<!doctype html><html lang=en><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><title>Engine API v1.24 | Docker Docs
</title><meta name=description content="API Documentation for Docker"><meta name=keywords content="[API,Docker,rcli,REST,documentation]"><link rel=canonical href="index.html"><link rel=icon type=image/x-icon href="../../../assets/favicons/docs@2x.ico" sizes=129x128><link rel=apple-touch-icon type=image/x-icon href="../../../assets/favicons/docs@2x.ico" sizes=129x128><meta name=msapplication-TileImage content="https://docs.docker.com/assets/favicons/docs@2x.ico"><meta name=theme-color content="#2496ed"><meta name=twitter:title itemprop="title name" content="Engine API v1.24"><meta name=twitter:description property="og:description" itemprop=description content="API Documentation for Docker"><meta name=twitter:card content="summary_large_image"><meta name=twitter:domain content="https://docs.docker.com"><meta name=twitter:site content="@docker_docs"><meta name=twitter:url content="https://twitter.com/docker_docs"><meta name=twitter:image:src content="https://docs.docker.com/assets/images/thumbnail.webp"><meta name=twitter:image:alt content="Docker Documentation"><meta property="og:title" content="Engine API v1.24"><meta property="og:description" content="API Documentation for Docker"><meta property="og:type" content="website"><meta property="og:updated_time" itemprop=dateUpdated content="2024-01-19 15:48:32 +0100 +0100"><meta property="og:image" itemprop="image primaryImageOfPage" content="https://docs.docker.com/assets/images/thumbnail.webp"><meta property="og:locale" content="en_US"><meta property="og:url" content="https://docs.docker.com/engine/api/v1.24/"><meta property="og:site_name" content="Docker Documentation"><meta property="article:published_time" itemprop=datePublished content="2024-01-19 15:48:32 +0100 +0100"><script type=application/ld+json>{"@context":"https://schema.org","@type":"WebPage","headline":"\"Engine API v1.24\"","description":"\"API Documentation for Docker\"","url":"https:\/\/docs.docker.com\/engine\/api\/v1.24\/"}</script><script src=https://cdn.cookielaw.org/scripttemplates/otSDKStub.js type=text/javascript data-domain-script=8e0ebfd9-035d-4ec2-9b2f-a2de9c09f906></script><script type=text/javascript>function OptanonWrapper(){}</script><script>(function(e,t,n,s,o){e[s]=e[s]||[],e[s].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var a=t.getElementsByTagName(n)[0],i=t.createElement(n),r=s!="dataLayer"?"&l="+s:"";i.async=!0,i.src="https://www.googletagmanager.com/gtm.js?id="+o+r,a.parentNode.insertBefore(i,a)})(window,document,"script","dataLayer","GTM-WL2QLG5")</script><script>(function(e,t,n,s,o,i){e.hj=e.hj||function(){(e.hj.q=e.hj.q||[]).push(arguments)},e._hjSettings={hjid:3169877,hjsv:6},o=t.getElementsByTagName("head")[0],i=t.createElement("script"),i.async=1,i.src=n+e._hjSettings.hjid+s+e._hjSettings.hjsv,o.appendChild(i)})(window,document,"https://static.hotjar.com/c/hotjar-",".js?sv=")</script><link href="../../../assets/fonts/RobotoFlex.woff2" rel=preload as=font type=font/woff2 crossorigin><style>body>img{display:none}</style><link href="../../../css/styles.min.8767cc26123e21700c497beebf1cbd8dfdfec3499469fd8793a873c11b567264.css" rel=stylesheet><script>(()=>{function t(){let e=localStorage.getItem("theme-preference");return e||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")}var e=t();document.firstElementChild.className=e==="dark"?"dark":"light",localStorage.setItem("theme-preference",e)})()</script><script defer src="../../../scripts.js"></script><link rel=preconnect href=https://3XRLW0LZH9-dsn.algolia.net crossorigin></head><body class="bg-background-light text-base dark:bg-background-dark dark:text-white"><header class="sticky top-0 z-20 h-16 px-4 text-white bg-gradient-to-r from-accent-light to-blue-light-500 dark:from-accent-dark dark:to-blue-dark-100"><div class="mx-auto flex h-full max-w-[1400px] items-center justify-between"><div class="flex h-full items-center gap-8 md:gap-2"><button x-data @click="() => {
      $store.showSidebar = ! $store.showSidebar;
      const sidebar = document.querySelector('#sidebar');
      if ($store.showSidebar) {
        sidebar.classList.replace('md:hidden', 'md:block');
      } else {
        sidebar.classList.replace('md:block', 'md:hidden');
      }
      }" class="icon-svg hidden px-4 md:block" aria-label=Menu><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M150-240q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T150-3e2h660q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T810-240H150zm0-210q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T150-510h660q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T810-450H150zm0-210q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T150-720h660q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T810-660H150z"/></svg></button><div><a title="Docker Docs home page" href="../../../index.html"><div><svg width="92" height="33" viewBox="0 0 92 33" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M31.4783 13.9171C30.6936 13.3542 28.6325 13.1137 27.1335 13.5441 27.0527 11.9527 26.2826 10.6119 24.8747 9.44209L24.3529 9.06908 24.0051 9.62859C23.3219 10.7333 23.0351 12.2054 23.1366 13.5441 23.2173 14.3684 23.4865 15.2954 24.0051 15.9686 22.0548 17.1748 20.2566 16.9011 12.2938 16.9011H.00279151C-.0334407 18.818.256417 22.505 2.4552 25.5056 2.69847 25.8367 2.96452 26.1578 3.25334 26.4668c1.7878 1.9092 4.48969 3.3085 8.53006 3.313C17.9471 29.7853 23.2277 26.234 26.4399 17.6471 27.4969 17.6659 30.2867 17.8491 31.6522 15.0361 31.6853 14.9886 32 14.2901 32 14.2901L31.4783 13.9171zM8.02461 11.9395H4.56805v3.6848H8.02461V11.9395zm4.46589.0H9.03394v3.6848H12.4905V11.9395zm4.4659.0H13.4998v3.6848h3.4566V11.9395zm4.4659.0H17.9657v3.6848h3.4566V11.9395zm-17.86461.0H.102171v3.6848H3.55873L3.55769 11.9395zM8.02357 7.28461H4.56702V10.9694H8.02357V7.28461zm4.46593.0H9.0329V10.9694h3.4566V7.28461zm4.4658.0H13.4988V10.9694h3.4565V7.28461zm0-4.65485H13.4988V6.31458h3.4565V2.62976z" fill="#fff"/><path d="M78.9658 8.41589C78.4538 8.41589 78.0459 8.81327 78.0459 9.30828 78.0459 9.81422 78.4538 10.2116 78.9658 10.2116 79.4827 10.2116 79.8801 9.81422 79.8801 9.30828 79.8797 8.81327 79.4823 8.41589 78.9658 8.41589zM78.9711 10.0216C78.5685 10.0216 78.2744 9.70606 78.2744 9.30868 78.2744 8.91697 78.5684 8.59575 78.9658 8.59575 79.3628 8.59575 79.6512 8.91697 79.6512 9.31435 79.6512 9.70606 79.3628 10.0216 78.9711 10.0216z" fill="#fff"/><path d="M79.1725 9.33586V9.32492C79.281 9.29211 79.3572 9.21636 79.3572 9.11793 79.3572 9.03083 79.3191 8.95995 79.2701 8.92227 79.2049 8.8842 79.1287 8.85706 78.9598 8.85706 78.8132 8.85706 78.6985 8.86799 78.6171 8.8846V9.77699H78.8241V9.41768H78.9217C79.0364 9.41768 79.0907 9.46143 79.1069 9.55906 79.134 9.66275 79.1502 9.74418 79.1777 9.77699H79.4009C79.3791 9.74418 79.3625 9.68989 79.3357 9.55379 79.3082 9.43348 79.2592 9.36826 79.1725 9.33586zM78.9274 9.27064H78.8298V9.01504C78.8517 9.00937 78.8893 9.0037 78.944 9.0037 79.0749 9.0037 79.1344 9.05838 79.1344 9.14021 79.134 9.23256 79.0416 9.27064 78.9274 9.27064z" fill="#fff"/><path d="M41.5015 10.32C42.47 10.32 43.285 9.9708 43.9785 9.27042 44.6631 8.57936 45.003 7.73518 45.003 6.73747V.752051C45.003.560855 44.9402.400849 44.8122.27568 44.6842.150511 44.5307.0869141 44.3463.0869141 44.158.0869141 44.0041.150511 43.8809.27568 43.7574.400849 43.697.560855 43.697.752051V3.94284C43.0639 3.41949 42.3327 3.15537 41.5015 3.15537 40.5354 3.15537 39.7086 3.50415 39.0244 4.20493 38.3399 4.90288 38 5.74746 38 6.73788 38 7.72829 38.3423 8.57045 39.0244 9.27082 39.7086 9.96877 40.533 10.32 41.5015 10.32zM39.4806 5.86736C39.5948 5.59394 39.7507 5.35778 39.946 5.15524 40.1416 4.9523 40.3746 4.79189 40.6399 4.67198 40.9076 4.55168 41.194 4.49294 41.5035 4.49294S42.0925 4.55168 42.3603 4.67198C42.628 4.79229 42.8585 4.9527 43.0566 5.15767 43.2547 5.36264 43.4106 5.60082 43.5244 5.86979 43.6387 6.1412 43.6966 6.4288 43.6966 6.73545 43.6966 7.04209 43.6383 7.33213 43.5244 7.6011V7.60596C43.4102 7.87736 43.2543 8.11554 43.0566 8.31808 42.8589 8.52346 42.626 8.68346 42.3603 8.80377 42.0925 8.92408 41.8085 8.98281 41.5035 8.98281S40.9076 8.92408 40.6399 8.80377C40.3721 8.68346 40.1416 8.52305 39.946 8.32011 39.7503 8.11716 39.5944 7.87898 39.4806 7.60798 39.3663 7.33456 39.3084 7.04452 39.3084 6.73788 39.308 6.43123 39.3663 6.1412 39.4806 5.86736z" fill="#fff"/><path d="M72.9696 8.97333C72.9696 8.78699 72.9092 8.62212 72.7853 8.49695 72.6621 8.37179 72.5062 8.30819 72.3198 8.30819 72.157 8.31305 72.0124 8.36692 71.8892 8.47548 71.6936 8.64521 71.4817 8.77484 71.2512 8.8599 71.0207 8.94497 70.7692 8.9871 70.4946 8.9871 70.2523 8.9871 70.0194 8.94943 69.7982 8.87165 69.5767 8.79388 69.3701 8.68774 69.1858 8.5484 68.9994 8.40905 68.839 8.24419 68.7017 8.04853 68.5644 7.85531 68.4595 7.64062 68.3898 7.40487H73.3418C73.5253 7.40487 73.6793 7.34127 73.8073 7.2161S73.9981 6.93093 73.9981 6.73973c0-.49541-.0862999999999943-.95517-.256-1.37726C73.5719 4.93795 73.3131 4.55353 72.9736 4.20921L72.9692 4.20678C72.2777 3.50883 71.4509 3.15723 70.4921 3.15723 69.5325 3.15723 68.6993 3.5064 68.0147 4.20678 67.3301 4.90473 66.9902 5.74932 66.9902 6.73973S67.3325 8.5723 68.0147 9.27268C68.6993 9.97062 69.5236 10.3222 70.4921 10.3222 71.372 10.3222 72.1331 10.0322 72.7804 9.45212 72.906 9.31966 72.9696 9.15966 72.9696 8.97333zM68.6924 5.43093C68.8301 5.2377 68.9925 5.07 69.1793 4.93106 69.368 4.79212 69.5726 4.68558 69.7986 4.60781 70.0243 4.53003 70.2547 4.49236 70.4925 4.49236 70.7299 4.49236 70.9604 4.53003 71.1836 4.60781 71.4072 4.68558 71.6126 4.79171 71.7961 4.93106 71.9824 5.07 72.1452 5.23527 72.2826 5.43093 72.4223 5.62415 72.5272 5.83884 72.5997 6.07459H68.3853C68.4526 5.84127 68.555 5.62658 68.6924 5.43093z" fill="#fff"/><path d="M75.3696 10.3222C75.5531 10.3222 75.7026 10.2562 75.8278 10.1265 75.9562 9.99692 76.0186 9.83894 76.0186 9.65747V6.74011c0-.3111.0582999999999885-.60357.1721-.8774C76.305 5.58928 76.4609 5.35312 76.6586 5.15058 76.8571 4.94764 77.0896 4.78723 77.3549 4.67178 77.6227 4.5539 77.9071 4.49476 78.2121 4.49476 78.5167 4.49476 78.8055 4.54904 79.0688 4.65517 79.1733 4.70216 79.2645 4.72606 79.3435 4.72606 79.4346 4.72606 79.5205 4.70945 79.5995 4.67421 79.6785 4.63897 79.7485 4.59157 79.8069 4.53041 79.8652 4.46924 79.9114 4.39835 79.9466 4.31572 79.9814 4.23551 80.0001 4.14842 80.0001 4.05404 80.0001 3.87013 79.9417 3.72147 79.8255 3.60602H79.8279C79.7117 3.49058 79.5646 3.40065 79.3876 3.33462 79.2106 3.26859 79.0174 3.22363 78.8055 3.19771 78.5957 3.17178 78.398 3.16003 78.2145 3.16003 77.7977 3.16003 77.4064 3.22849 77.0386 3.365 76.6708 3.50192 76.3305 3.69757 76.0186 3.95236V3.82517C76.0186 3.64127 75.9558 3.48571 75.8278 3.35568 75.7002 3.22606 75.5487 3.16003 75.3696 3.16003 75.1898 3.16003 75.0318 3.22606 74.9042 3.35568 74.7758 3.48531 74.713 3.64329 74.713 3.82517v5.8323C74.713 9.84137 74.7758 9.99692 74.9042 10.1265 75.0318 10.2562 75.1857 10.3222 75.3696 10.3222z" fill="#fff"/><path d="M52.4904 5.3649C52.3203 4.94281 52.0667 4.55596 51.7244 4.20678 51.0329 3.50883 50.2066 3.15723 49.2473 3.15723 48.2881 3.15723 47.4545 3.5064 46.7703 4.20678 46.0857 4.90473 45.7458 5.74932 45.7458 6.73973S46.0881 8.5723 46.7703 9.27268C47.4549 9.97062 48.2788 10.3222 49.2473 10.3222 50.2159 10.3222 51.0309 9.97305 51.7244 9.27268 52.409 8.58161 52.7488 7.73743 52.7488 6.73973 52.744 6.24472 52.6581 5.78699 52.4904 5.3649zM51.2703 7.60052V7.60538C51.1561 7.87678 51.0001 8.11497 50.8024 8.31751 50.6043 8.52288 50.3718 8.68288 50.1061 8.80319 49.8408 8.9235 49.5544 8.98224 49.2494 8.98224 48.9443 8.98224 48.6535 8.9235 48.3857 8.80319 48.118 8.68288 47.8875 8.52247 47.6918 8.31953 47.4962 8.11659 47.3402 7.8784 47.2264 7.6074 47.1122 7.33398 47.0543 7.04394 47.0543 6.7373 47.0543 6.43066 47.1126 6.14062 47.2264 5.86719 47.3406 5.59376 47.4966 5.35761 47.6918 5.15507 47.8875 4.95212 48.1204 4.79171 48.3857 4.67181 48.6535 4.5515 48.9399 4.49276 49.2494 4.49276 49.5588 4.49276 49.8383 4.5515 50.1061 4.67181S50.6043 4.95253 50.8024 5.1575C51.0005 5.36247 51.1565 5.60065 51.2703 5.86962 51.3845 6.14102 51.4425 6.42863 51.4425 6.73527 51.4429 7.04192 51.3845 7.33195 51.2703 7.60052z" fill="#fff"/><path d="M63.628 6.08918 66.2472 4.34856C66.4141 4.23352 66.4955 4.05731 66.4963 3.82034 66.4959 3.73163 66.4777 3.64737 66.4428 3.56798 66.408 3.48777 66.3614 3.41486 66.3031 3.35328 66.2448 3.29212 66.1751 3.24229 66.0957 3.20948 66.0167 3.17667 65.9304 3.15763 65.8397 3.15763 65.7092 3.15763 65.593 3.19085 65.4905 3.2589L61.7516 5.74689V.75674C61.7516.567974 61.6889.409993 61.5609.280369 61.4329.150744 61.2814.0847168 61.1023.0847168 60.9233.0847168 60.7649.150744 60.6365.280369 60.5085.409993 60.4457.567974 60.4457.75674V9.64778C60.4457 9.83168 60.5085 9.98966 60.6365 10.1217 60.7645 10.2538 60.9184 10.3198 61.1023 10.3198S61.4353 10.2538 61.5609 10.1217C61.6889 9.98966 61.7516 9.83168 61.7516 9.64778V7.33884L62.5152 6.82723l2.8894 3.31797C65.5209 10.2607 65.6675 10.3174 65.8421 10.3174 65.9329 10.3174 66.0191 10.3008 66.0981 10.2655 66.1771 10.2323 66.2472 10.1829 66.3055 10.1217 66.3639 10.0606 66.4104 9.98966 66.4453 9.90703 66.4801 9.82682 66.4987 9.73973 66.4987 9.65223 66.4987 9.47764 66.4384 9.3221 66.3173 9.18518l-2.6893-3.096z" fill="#fff"/><path d="M56.9841 10.3247C57.8595 10.3247 58.621 10.0346 59.2659 9.45457 59.4032 9.31319 59.4733 9.15035 59.4733 8.96159 59.4733 8.77282 59.4126 8.60998 59.2894 8.48522 59.1659 8.36005 59.0099 8.29645 58.824 8.29645 58.6656 8.30131 58.5283 8.3483 58.412 8.43782 58.2026 8.62173 57.9838 8.75864 57.7485 8.8506 57.5156 8.94255 57.262 8.98751 56.9849 8.98751 56.6799 8.98751 56.3959 8.92837 56.1282 8.81049 55.8604 8.69262 55.6275 8.53221 55.4274 8.33169 55.2273 8.13118 55.0689 7.89056 54.9547 7.61957 54.8404 7.34614 54.7825 7.05368 54.7825 6.74217 54.7825 6.43067 54.8409 6.1386 54.9547 5.86477 55.0689 5.59135 55.2269 5.35519 55.4274 5.15265V5.15022C55.6275 4.94727 55.8604 4.78686 56.1282 4.67142 56.3959 4.55354 56.6799 4.4944 56.9849 4.4944 57.2596 4.4944 57.5136 4.54139 57.7485 4.63577 57.9814 4.73015 58.205 4.86909 58.4165 5.05097 58.542 5.15224 58.6842 5.20409 58.8426 5.20409 59.0314 5.20409 59.1849 5.1405 59.3084 5.0133 59.432 4.88611 59.4924 4.7257 59.4924 4.5345 59.4924 4.34371 59.4178 4.16669 59.2663 4.02977 58.6239 3.4497 57.8623 3.15967 56.9845 3.15967c-.966099999999997.0-1.7929.34917-2.477 1.04955C53.8229 4.90717 53.483 5.75135 53.483 6.74217 53.483 7.73258 53.8253 8.57474 54.5075 9.27512 55.1912 9.97306 56.0156 10.3247 56.9841 10.3247z" fill="#fff"/><path d="M44.774 32.4167C43.578 32.4167 42.497 32.1407 41.531 31.5887 40.5803 31.0214 39.8213 30.2547 39.254 29.2887 38.702 28.3227 38.426 27.234 38.426 26.0227s.253-2.2923.759-3.243C39.7063 21.8137 40.4117 21.0547 41.301 20.5027 42.1903 19.9354 43.1947 19.6517 44.314 19.6517 45.2187 19.6517 46.0543 19.8434 46.821 20.2267 47.5877 20.5947 48.2317 21.1007 48.753 21.7447v-6.21C48.753 15.182 48.8603 14.8984 49.075 14.6837 49.305 14.469 49.5887 14.3617 49.926 14.3617 50.2787 14.3617 50.5623 14.469 50.777 14.6837S51.099 15.182 51.099 15.5347v10.488C51.099 27.234 50.8153 28.3227 50.248 29.2887 49.696 30.2547 48.9447 31.0214 47.994 31.5887 47.0433 32.1407 45.97 32.4167 44.774 32.4167zm0-2.07C45.556 30.3467 46.2537 30.1627 46.867 29.7947 47.4803 29.4114 47.9633 28.89 48.316 28.2307 48.6687 27.5714 48.845 26.8354 48.845 26.0227 48.845 25.1947 48.6687 24.4587 48.316 23.8147 47.9633 23.1707 47.4803 22.6647 46.867 22.2967 46.2537 21.9134 45.556 21.7217 44.774 21.7217 44.0073 21.7217 43.3097 21.9134 42.681 22.2967 42.0677 22.6647 41.577 23.1707 41.209 23.8147 40.8563 24.4587 40.68 25.1947 40.68 26.0227 40.68 26.8354 40.8563 27.5714 41.209 28.2307 41.577 28.89 42.0677 29.4114 42.681 29.7947 43.3097 30.1627 44.0073 30.3467 44.774 30.3467zm15.1719 2.07c-1.242.0-2.3384-.268299999999996-3.289-.805-.950699999999998-.552-1.702-1.3033-2.254-2.254C53.8662 28.3917 53.5979 27.2877 53.5979 26.0457c0-1.2573.268299999999996-2.3613.805-3.312.552-.965999999999998 1.3033-1.7173 2.254-2.254C57.6075 19.9277 58.7039 19.6517 59.9459 19.6517c1.2266.0 2.3153.276 3.266.827999999999999C64.1625 21.0164 64.9062 21.7677 65.4429 22.7337 65.9949 23.6844 66.2709 24.7884 66.2709 26.0457c0 1.242-.2684 2.346-.804999999999993 3.312C64.9292 30.3084 64.1855 31.0597 63.2349 31.6117 62.2842 32.1484 61.1879 32.4167 59.9459 32.4167zm0-2.07c.7973.0 1.5026-.183999999999998 2.116-.552C62.6752 29.4267 63.1505 28.9207 63.4879 28.2767 63.8405 27.6327 64.0169 26.889 64.0169 26.0457S63.8405 24.4587 63.4879 23.8147C63.1505 23.1554 62.6752 22.6417 62.0619 22.2737 61.4485 21.9057 60.7432 21.7217 59.9459 21.7217 59.1485 21.7217 58.4432 21.9057 57.8299 22.2737 57.2165 22.6417 56.7335 23.1554 56.3809 23.8147 56.0282 24.4587 55.8519 25.2024 55.8519 26.0457S56.0282 27.6327 56.3809 28.2767C56.7335 28.9207 57.2165 29.4267 57.8299 29.7947 58.4432 30.1627 59.1485 30.3467 59.9459 30.3467zm14.5205 2.07C73.2397 32.4167 72.1434 32.1407 71.1774 31.5887 70.2267 31.0214 69.4754 30.2624 68.9234 29.3117 68.3867 28.3457 68.1184 27.257 68.1184 26.0457 68.1184 24.8037 68.3867 23.6997 68.9234 22.7337 69.46 21.7677 70.196 21.0164 71.1314 20.4797 72.0667 19.9277 73.14 19.6517 74.3514 19.6517 75.256 19.6517 76.084 19.828 76.8354 20.1807 77.5867 20.518 78.2614 21.0317 78.8594 21.7217 79.0741 21.967 79.1507 22.22 79.0894 22.4807S78.8594 22.9714 78.5834 23.1707C78.3687 23.324 78.1311 23.3777 77.8704 23.3317 77.6097 23.2704 77.372 23.1324 77.1574 22.9177 76.406 22.1204 75.4707 21.7217 74.3514 21.7217 73.5694 21.7217 72.8794 21.9057 72.2814 22.2737 71.6834 22.6264 71.2157 23.1247 70.8784 23.7687 70.541 24.4127 70.3724 25.1717 70.3724 26.0457 70.3724 26.8737 70.541 27.6097 70.8784 28.2537 71.231 28.8977 71.714 29.4114 72.3274 29.7947 72.9407 30.1627 73.6537 30.3467 74.4664 30.3467 75.0031 30.3467 75.4707 30.2854 75.8694 30.1627 76.2834 30.0247 76.6591 29.8177 76.9964 29.5417 77.2417 29.3424 77.4947 29.235 77.7554 29.2197 78.0161 29.189 78.2461 29.258 78.4454 29.4267 78.706 29.6414 78.8517 29.8867 78.8824 30.1627 78.913 30.4234 78.821 30.661 78.6064 30.8757 77.5024 31.903 76.1224 32.4167 74.4664 32.4167zm11.6865.0C85.0795 32.4167 84.0829 32.2557 83.1629 31.9337 82.2582 31.5964 81.5529 31.1747 81.0469 30.6687 80.8169 30.4234 80.7172 30.1474 80.7479 29.8407 80.7939 29.5187 80.9472 29.258 81.2079 29.0587 81.5145 28.8134 81.8135 28.7137 82.1049 28.7597 82.4115 28.7904 82.6722 28.9207 82.8869 29.1507 83.1475 29.442 83.5615 29.718 84.1289 29.9787 84.7115 30.224 85.3555 30.3467 86.0609 30.3467 86.9502 30.3467 87.6249 30.201 88.0849 29.9097 88.5602 29.6184 88.8055 29.2427 88.8209 28.7827 88.8362 28.3227 88.6139 27.924 88.1539 27.5867 87.7092 27.2494 86.8889 26.9734 85.6929 26.7587 84.1442 26.452 83.0172 25.992 82.3119 25.3787 81.6219 24.7654 81.2769 24.014 81.2769 23.1247 81.2769 22.3427 81.5069 21.6987 81.9669 21.1927 82.4269 20.6714 83.0172 20.288 83.7379 20.0427 84.4585 19.782 85.2099 19.6517 85.9919 19.6517 87.0039 19.6517 87.9009 19.8127 88.6829 20.1347 89.4649 20.4567 90.0859 20.9014 90.5459 21.4687 90.7605 21.714 90.8602 21.9747 90.8449 22.2507 90.8295 22.5114 90.6992 22.7337 90.4539 22.9177 90.2085 23.0864 89.9172 23.14 89.5799 23.0787 89.2425 23.0174 88.9589 22.8794 88.7289 22.6647 88.3455 22.2967 87.9315 22.0437 87.4869 21.9057 87.0422 21.7677 86.5285 21.6987 85.9459 21.6987 85.2712 21.6987 84.6962 21.8137 84.2209 22.0437 83.7609 22.2737 83.5309 22.611 83.5309 23.0557 83.5309 23.3317 83.5999 23.5847 83.7379 23.8147 83.8912 24.0294 84.1825 24.2287 84.6119 24.4127 85.0412 24.5814 85.6699 24.75 86.4979 24.9187 87.6479 25.1487 88.5525 25.44 89.2119 25.7927 89.8865 26.1454 90.3695 26.5594 90.6609 27.0347 90.9522 27.4947 91.0979 28.0314 91.0979 28.6447 91.0979 29.35 90.9062 29.9864 90.5229 30.5537 90.1549 31.121 89.6029 31.5734 88.8669 31.9107 88.1462 32.248 87.2415 32.4167 86.1529 32.4167z" fill="#fff"/></svg></div></a></div><div><nav><ul class="box-content flex mt-1 gap-4 md:hidden"><li><a class="block py-1 px-2" href="../../../get-started/overview/index.html">Guides</a></li><li><a class="block py-1 px-2" href="../../../manuals/index.html">Manuals</a></li><li class=border-b-4><a class="block py-1 px-2" href="../../../app/working-with-app/index.html">Reference</a></li><li><a class="block py-1 px-2" href="../../../samples/index.html">Samples</a></li><li><a class="block py-1 px-2" href="../../../faq/index.html">FAQ</a></li></ul></nav></div></div><div class="flex items-center gap-6"><div id=docsearch></div><button aria-label="Theme switch" id=theme-switch class=svg-icon x-data="{ theme: localStorage.getItem('theme-preference') }" x-init="$watch('theme', value => {
        localStorage.setItem('theme-preference', value);
        document.firstElementChild.className = value;
      })" @click="theme = (theme === 'dark' ? 'light' : 'dark')">
<span class="icon-svg dark:hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-280q-83 0-141.5-58.5T280-480t58.5-141.5T480-680t141.5 58.5T680-480t-58.5 141.5T480-280zM70-450q-12.75.0-21.375-8.675Q40-467.351 40-480.175 40-493 48.625-501.5T70-510h1e2q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T170-450H70zm720 0q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T790-510h1e2q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T890-450H790zM479.825-760Q467-760 458.5-768.625T450-790v-1e2q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T510-890v1e2q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625zm0 720Q467-40 458.5-48.625T450-70v-1e2q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T510-170v1e2q0 12.75-8.675 21.375Q492.649-40 479.825-40zM240-678l-57-56q-9-9-8.629-21.603.37-12.604 8.526-21.5 8.896-8.897 21.5-8.897Q217-786 226-777l56 57q8 9 8 21t-8 20.5-20.5 8.5-21.5-8zm494 495-56-57q-8-9-8-21.375T678.5-282q8.5-9 20.5-9t21 9l57 56q9 9 8.629 21.603-.37 12.604-8.526 21.5-8.896 8.897-21.5 8.897Q743-174 734-183zm-56-495q-9-9-9-21t9-21l56-57q9-9 21.603-8.629 12.604.37 21.5 8.526 8.897 8.896 8.897 21.5Q786-743 777-734l-57 56q-8 8-20.364 8-12.363.0-21.636-8zM182.897-182.897q-8.897-8.896-8.897-21.5Q174-217 183-226l57-56q8.8-9 20.9-9 12.1.0 20.709 9Q291-273 291-261t-9 21l-56 57q-9 9-21.603 8.629-12.604-.37-21.5-8.526z"/></svg></span>
<span class="icon-svg hidden dark:block"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-120q-150 0-255-105T120-480q0-135 79.5-229T408-830q20-5 34-1t22 15q8 10 7.5 25t-8.5 35q-9 23-14 47t-5 49q0 90 63 153t153 63q25 0 48.5-4.5T754-461t38-7 26 9 13 23-2 36q-27 121-121 200.5T480-120z"/></svg></span></button></div></div></header><main class=flex><div id=sidebar class="sticky top-16 flex h-screen shrink-0 grow flex-row-reverse overflow-y-scroll bg-background-light dark:bg-gray-dark-100 md:fixed md:z-10 md:hidden md:h-screen md:w-screen lg:grow-0"><nav class="text-sm py-4 hidden gap-4 pl-4 md:flex flex-col justify-evenly"><div class="text-gray-light dark:text-gray-dark">Main sections</div><div class="pl-2 underline-offset-8 decoration-2 hover:underline decoration-blue-light dark:decoration-blue-dark hover:opacity-75"><a href="../../../get-started/overview/index.html">Guides</a></div><div class="pl-2 underline-offset-8 decoration-2 hover:underline decoration-blue-light dark:decoration-blue-dark hover:opacity-75"><a href="../../../manuals/index.html">Manuals</a></div><div class="pl-2 underline-offset-8 decoration-2 hover:underline decoration-blue-light dark:decoration-blue-dark hover:opacity-75
underline"><a href="../../../app/working-with-app/index.html">Reference</a></div><div class="pl-2 underline-offset-8 decoration-2 hover:underline decoration-blue-light dark:decoration-blue-dark hover:opacity-75"><a href="../../../samples/index.html">Samples</a></div><div class="pl-2 underline-offset-8 decoration-2 hover:underline decoration-blue-light dark:decoration-blue-dark hover:opacity-75"><a href="../../../faq/index.html">FAQ</a></div></nav><hr><nav id=sectiontree class="text-sm w-[300px] md:w-full flex flex-col"><div class="hidden md:block p-4 text-gray-light dark:text-gray-dark">This section</div><ul><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../app/working-with-app/index.html" title="Reference documentation"><span class="flex items-center gap-2">Reference documentation</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">CLI reference
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/index.html" title="docker (base command)"><span class="flex items-center gap-2">docker (base command)</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/build/index.html" title="docker build"><span class="flex items-center gap-2">docker build</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker builder
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/builder/index.html" title="docker builder"><span class="flex items-center gap-2">docker builder</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/builder/build/index.html" title="docker builder build"><span class="flex items-center gap-2">docker builder build</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/builder/prune/index.html" title="docker builder prune"><span class="flex items-center gap-2">docker builder prune</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker buildx
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/index.html" title="docker buildx"><span class="flex items-center gap-2">docker buildx</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/bake/index.html" title="docker buildx bake"><span class="flex items-center gap-2">docker buildx bake</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../reference/commandline/buildx_build/index.html" title="docker buildx build"><span class="flex items-center gap-2">docker buildx build</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/create/index.html" title="docker buildx create"><span class="flex items-center gap-2">docker buildx create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/debug/index.html" title="docker buildx debug"><span class="flex items-center gap-2">docker buildx debug</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/debug/build/index.html" title="docker buildx debug build"><span class="flex items-center gap-2">docker buildx debug build</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/du/index.html" title="docker buildx du"><span class="flex items-center gap-2">docker buildx du</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/imagetools/index.html" title="docker buildx imagetools"><span class="flex items-center gap-2">docker buildx imagetools</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/imagetools/create/index.html" title="docker buildx imagetools create"><span class="flex items-center gap-2">docker buildx imagetools create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/imagetools/inspect/index.html" title="docker buildx imagetools inspect"><span class="flex items-center gap-2">docker buildx imagetools inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/inspect/index.html" title="docker buildx inspect"><span class="flex items-center gap-2">docker buildx inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/ls/index.html" title="docker buildx ls"><span class="flex items-center gap-2">docker buildx ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/prune/index.html" title="docker buildx prune"><span class="flex items-center gap-2">docker buildx prune</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/rm/index.html" title="docker buildx rm"><span class="flex items-center gap-2">docker buildx rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/stop/index.html" title="docker buildx stop"><span class="flex items-center gap-2">docker buildx stop</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/use/index.html" title="docker buildx use"><span class="flex items-center gap-2">docker buildx use</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/buildx/version/index.html" title="docker buildx version"><span class="flex items-center gap-2">docker buildx version</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker checkpoint
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/checkpoint/index.html" title="docker checkpoint"><span class="flex items-center gap-2">docker checkpoint</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/checkpoint/create/index.html" title="docker checkpoint create"><span class="flex items-center gap-2">docker checkpoint create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/checkpoint/ls/index.html" title="docker checkpoint ls"><span class="flex items-center gap-2">docker checkpoint ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/checkpoint/rm/index.html" title="docker checkpoint rm"><span class="flex items-center gap-2">docker checkpoint rm</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker compose
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/reference/index.html" title=overview><span class="flex items-center gap-2">overview</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/alpha/index.html" title="docker compose alpha"><span class="flex items-center gap-2">docker compose alpha</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/alpha/dry-run/index.html" title="docker compose alpha dry-run"><span class="flex items-center gap-2">docker compose alpha dry-run</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/alpha/publish/index.html" title="docker compose alpha publish"><span class="flex items-center gap-2">docker compose alpha publish</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/alpha/scale/index.html" title="docker compose alpha scale"><span class="flex items-center gap-2">docker compose alpha scale</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/alpha/viz/index.html" title="docker compose alpha viz"><span class="flex items-center gap-2">docker compose alpha viz</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/index.html" title="docker compose"><span class="flex items-center gap-2">docker compose</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/build/index.html" title="docker compose build"><span class="flex items-center gap-2">docker compose build</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/config/index.html" title="docker compose config"><span class="flex items-center gap-2">docker compose config</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/cp/index.html" title="docker compose cp"><span class="flex items-center gap-2">docker compose cp</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/create/index.html" title="docker compose create"><span class="flex items-center gap-2">docker compose create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/down/index.html" title="docker compose down"><span class="flex items-center gap-2">docker compose down</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/events/index.html" title="docker compose events"><span class="flex items-center gap-2">docker compose events</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/exec/index.html" title="docker compose exec"><span class="flex items-center gap-2">docker compose exec</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/images/index.html" title="docker compose images"><span class="flex items-center gap-2">docker compose images</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/kill/index.html" title="docker compose kill"><span class="flex items-center gap-2">docker compose kill</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/logs/index.html" title="docker compose logs"><span class="flex items-center gap-2">docker compose logs</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/ls/index.html" title="docker compose ls"><span class="flex items-center gap-2">docker compose ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/pause/index.html" title="docker compose pause"><span class="flex items-center gap-2">docker compose pause</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/port/index.html" title="docker compose port"><span class="flex items-center gap-2">docker compose port</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/ps/index.html" title="docker compose ps"><span class="flex items-center gap-2">docker compose ps</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/pull/index.html" title="docker compose pull"><span class="flex items-center gap-2">docker compose pull</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/push/index.html" title="docker compose push"><span class="flex items-center gap-2">docker compose push</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/restart/index.html" title="docker compose restart"><span class="flex items-center gap-2">docker compose restart</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/rm/index.html" title="docker compose rm"><span class="flex items-center gap-2">docker compose rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/run/index.html" title="docker compose run"><span class="flex items-center gap-2">docker compose run</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/start/index.html" title="docker compose start"><span class="flex items-center gap-2">docker compose start</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/stop/index.html" title="docker compose stop"><span class="flex items-center gap-2">docker compose stop</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/top/index.html" title="docker compose top"><span class="flex items-center gap-2">docker compose top</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/unpause/index.html" title="docker compose unpause"><span class="flex items-center gap-2">docker compose unpause</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/up/index.html" title="docker compose up"><span class="flex items-center gap-2">docker compose up</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/version/index.html" title="docker compose version"><span class="flex items-center gap-2">docker compose version</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/wait/index.html" title="docker compose wait"><span class="flex items-center gap-2">docker compose wait</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/compose/watch/index.html" title="docker compose watch"><span class="flex items-center gap-2">docker compose watch</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker config
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/config/index.html" title="docker config"><span class="flex items-center gap-2">docker config</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/config/create/index.html" title="docker config create"><span class="flex items-center gap-2">docker config create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/config/inspect/index.html" title="docker config inspect"><span class="flex items-center gap-2">docker config inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/config/ls/index.html" title="docker config ls"><span class="flex items-center gap-2">docker config ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/config/rm/index.html" title="docker config rm"><span class="flex items-center gap-2">docker config rm</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker container
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/index.html" title="docker container"><span class="flex items-center gap-2">docker container</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/attach/index.html" title="docker container attach"><span class="flex items-center gap-2">docker container attach</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/commit/index.html" title="docker container commit"><span class="flex items-center gap-2">docker container commit</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/cp/index.html" title="docker container cp"><span class="flex items-center gap-2">docker container cp</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/create/index.html" title="docker container create"><span class="flex items-center gap-2">docker container create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/diff/index.html" title="docker container diff"><span class="flex items-center gap-2">docker container diff</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/exec/index.html" title="docker container exec"><span class="flex items-center gap-2">docker container exec</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/export/index.html" title="docker container export"><span class="flex items-center gap-2">docker container export</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/inspect/index.html" title="docker container inspect"><span class="flex items-center gap-2">docker container inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/kill/index.html" title="docker container kill"><span class="flex items-center gap-2">docker container kill</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/logs/index.html" title="docker container logs"><span class="flex items-center gap-2">docker container logs</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/ps/index.html" title="docker container ls"><span class="flex items-center gap-2">docker container ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/pause/index.html" title="docker container pause"><span class="flex items-center gap-2">docker container pause</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/port/index.html" title="docker container port"><span class="flex items-center gap-2">docker container port</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/prune/index.html" title="docker container prune"><span class="flex items-center gap-2">docker container prune</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/rename/index.html" title="docker container rename"><span class="flex items-center gap-2">docker container rename</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/restart/index.html" title="docker container restart"><span class="flex items-center gap-2">docker container restart</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/rm/index.html" title="docker container rm"><span class="flex items-center gap-2">docker container rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../reference/commandline/run/index.html" title="docker container run"><span class="flex items-center gap-2">docker container run</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/start/index.html" title="docker container start"><span class="flex items-center gap-2">docker container start</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/stats/index.html" title="docker container stats"><span class="flex items-center gap-2">docker container stats</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/stop/index.html" title="docker container stop"><span class="flex items-center gap-2">docker container stop</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/top/index.html" title="docker container top"><span class="flex items-center gap-2">docker container top</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/unpause/index.html" title="docker container unpause"><span class="flex items-center gap-2">docker container unpause</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/update/index.html" title="docker container update"><span class="flex items-center gap-2">docker container update</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/container/wait/index.html" title="docker container wait"><span class="flex items-center gap-2">docker container wait</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker context
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/index.html" title="docker context"><span class="flex items-center gap-2">docker context</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/create/index.html" title="docker context create"><span class="flex items-center gap-2">docker context create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/export/index.html" title="docker context export"><span class="flex items-center gap-2">docker context export</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/import/index.html" title="docker context import"><span class="flex items-center gap-2">docker context import</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/inspect/index.html" title="docker context inspect"><span class="flex items-center gap-2">docker context inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/ls/index.html" title="docker context ls"><span class="flex items-center gap-2">docker context ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/rm/index.html" title="docker context rm"><span class="flex items-center gap-2">docker context rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/show/index.html" title="docker context show"><span class="flex items-center gap-2">docker context show</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/update/index.html" title="docker context update"><span class="flex items-center gap-2">docker context update</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/context/use/index.html" title="docker context use"><span class="flex items-center gap-2">docker context use</span></a></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/debug/index.html" title="docker debug (Beta)"><span class="flex items-center gap-2">docker debug (Beta)</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/exec/index.html" title="docker exec"><span class="flex items-center gap-2">docker exec</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker image
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/index.html" title="docker image"><span class="flex items-center gap-2">docker image</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/builder/build/index.html" title="docker image build"><span class="flex items-center gap-2">docker image build</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/history/index.html" title="docker image history"><span class="flex items-center gap-2">docker image history</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/import/index.html" title="docker image import"><span class="flex items-center gap-2">docker image import</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/inspect/index.html" title="docker image inspect"><span class="flex items-center gap-2">docker image inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/load/index.html" title="docker image load"><span class="flex items-center gap-2">docker image load</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/images/index.html" title="docker image ls"><span class="flex items-center gap-2">docker image ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/prune/index.html" title="docker image prune"><span class="flex items-center gap-2">docker image prune</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/pull/index.html" title="docker image pull"><span class="flex items-center gap-2">docker image pull</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/push/index.html" title="docker image push"><span class="flex items-center gap-2">docker image push</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/rm/index.html" title="docker image rm"><span class="flex items-center gap-2">docker image rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/save/index.html" title="docker image save"><span class="flex items-center gap-2">docker image save</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/image/tag/index.html" title="docker image tag"><span class="flex items-center gap-2">docker image tag</span></a></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/images/index.html" title="docker images"><span class="flex items-center gap-2">docker images</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/info/index.html" title="docker info"><span class="flex items-center gap-2">docker info</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/init/index.html" title="docker init"><span class="flex items-center gap-2">docker init</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/inspect/index.html" title="docker inspect"><span class="flex items-center gap-2">docker inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/login/index.html" title="docker login"><span class="flex items-center gap-2">docker login</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/logout/index.html" title="docker logout"><span class="flex items-center gap-2">docker logout</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker manifest
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/manifest/index.html" title="docker manifest"><span class="flex items-center gap-2">docker manifest</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/manifest/annotate/index.html" title="docker manifest annotate"><span class="flex items-center gap-2">docker manifest annotate</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/manifest/create/index.html" title="docker manifest create"><span class="flex items-center gap-2">docker manifest create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/manifest/inspect/index.html" title="docker manifest inspect"><span class="flex items-center gap-2">docker manifest inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/manifest/push/index.html" title="docker manifest push"><span class="flex items-center gap-2">docker manifest push</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/manifest/rm/index.html" title="docker manifest rm"><span class="flex items-center gap-2">docker manifest rm</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker network
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/index.html" title="docker network"><span class="flex items-center gap-2">docker network</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/connect/index.html" title="docker network connect"><span class="flex items-center gap-2">docker network connect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/create/index.html" title="docker network create"><span class="flex items-center gap-2">docker network create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/disconnect/index.html" title="docker network disconnect"><span class="flex items-center gap-2">docker network disconnect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/inspect/index.html" title="docker network inspect"><span class="flex items-center gap-2">docker network inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/ls/index.html" title="docker network ls"><span class="flex items-center gap-2">docker network ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/prune/index.html" title="docker network prune"><span class="flex items-center gap-2">docker network prune</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/network/rm/index.html" title="docker network rm"><span class="flex items-center gap-2">docker network rm</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker node
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/index.html" title="docker node"><span class="flex items-center gap-2">docker node</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/demote/index.html" title="docker node demote"><span class="flex items-center gap-2">docker node demote</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/inspect/index.html" title="docker node inspect"><span class="flex items-center gap-2">docker node inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/ls/index.html" title="docker node ls"><span class="flex items-center gap-2">docker node ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/promote/index.html" title="docker node promote"><span class="flex items-center gap-2">docker node promote</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/ps/index.html" title="docker node ps"><span class="flex items-center gap-2">docker node ps</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/rm/index.html" title="docker node rm"><span class="flex items-center gap-2">docker node rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/node/update/index.html" title="docker node update"><span class="flex items-center gap-2">docker node update</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker plugin
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/index.html" title="docker plugin"><span class="flex items-center gap-2">docker plugin</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/create/index.html" title="docker plugin create"><span class="flex items-center gap-2">docker plugin create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/disable/index.html" title="docker plugin disable"><span class="flex items-center gap-2">docker plugin disable</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/enable/index.html" title="docker plugin enable"><span class="flex items-center gap-2">docker plugin enable</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/inspect/index.html" title="docker plugin inspect"><span class="flex items-center gap-2">docker plugin inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/install/index.html" title="docker plugin install"><span class="flex items-center gap-2">docker plugin install</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/ls/index.html" title="docker plugin ls"><span class="flex items-center gap-2">docker plugin ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/rm/index.html" title="docker plugin rm"><span class="flex items-center gap-2">docker plugin rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/set/index.html" title="docker plugin set"><span class="flex items-center gap-2">docker plugin set</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/plugin/upgrade/index.html" title="docker plugin upgrade"><span class="flex items-center gap-2">docker plugin upgrade</span></a></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/ps/index.html" title="docker ps"><span class="flex items-center gap-2">docker ps</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/pull/index.html" title="docker pull"><span class="flex items-center gap-2">docker pull</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/push/index.html" title="docker push"><span class="flex items-center gap-2">docker push</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/run/index.html" title="docker run"><span class="flex items-center gap-2">docker run</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker scout
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/index.html" title="docker scout"><span class="flex items-center gap-2">docker scout</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/attestation/index.html" title="docker scout attestation"><span class="flex items-center gap-2">docker scout attestation</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/attestation/add/index.html" title="docker scout attestation add"><span class="flex items-center gap-2">docker scout attestation add</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/cache/index.html" title="docker scout cache"><span class="flex items-center gap-2">docker scout cache</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/cache/df/index.html" title="docker scout cache df"><span class="flex items-center gap-2">docker scout cache df</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/cache/prune/index.html" title="docker scout cache prune"><span class="flex items-center gap-2">docker scout cache prune</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/compare/index.html" title="docker scout compare"><span class="flex items-center gap-2">docker scout compare</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/config/index.html" title="docker scout config"><span class="flex items-center gap-2">docker scout config</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/cves.html" title="docker scout cves"><span class="flex items-center gap-2">docker scout cves</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/enroll/index.html" title="docker scout enroll"><span class="flex items-center gap-2">docker scout enroll</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/environment/index.html" title="docker scout environment"><span class="flex items-center gap-2">docker scout environment</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/integration/index.html" title="docker scout integration"><span class="flex items-center gap-2">docker scout integration</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/integration/configure/index.html" title="docker scout integration configure"><span class="flex items-center gap-2">docker scout integration configure</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/integration/delete/index.html" title="docker scout integration delete"><span class="flex items-center gap-2">docker scout integration delete</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/integration/list/index.html" title="docker scout integration list"><span class="flex items-center gap-2">docker scout integration list</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/policy/index.html" title="docker scout policy"><span class="flex items-center gap-2">docker scout policy</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/quickview/index.html" title="docker scout quickview"><span class="flex items-center gap-2">docker scout quickview</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/recommendations/index.html" title="docker scout recommendations"><span class="flex items-center gap-2">docker scout recommendations</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/repo/index.html" title="docker scout repo"><span class="flex items-center gap-2">docker scout repo</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/repo/disable/index.html" title="docker scout repo disable"><span class="flex items-center gap-2">docker scout repo disable</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/repo/enable.html" title="docker scout repo enable"><span class="flex items-center gap-2">docker scout repo enable</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/repo/list/index.html" title="docker scout repo list"><span class="flex items-center gap-2">docker scout repo list</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/sbom/index.html" title="docker scout sbom"><span class="flex items-center gap-2">docker scout sbom</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/stream/index.html" title="docker scout stream"><span class="flex items-center gap-2">docker scout stream</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/version/index.html" title="docker scout version"><span class="flex items-center gap-2">docker scout version</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/scout/watch/index.html" title="docker scout watch"><span class="flex items-center gap-2">docker scout watch</span></a></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/search/index.html" title="docker search"><span class="flex items-center gap-2">docker search</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker secret
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/secret/index.html" title="docker secret"><span class="flex items-center gap-2">docker secret</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/secret/create/index.html" title="docker secret create"><span class="flex items-center gap-2">docker secret create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/secret/inspect/index.html" title="docker secret inspect"><span class="flex items-center gap-2">docker secret inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/secret/ls/index.html" title="docker secret ls"><span class="flex items-center gap-2">docker secret ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/secret/rm/index.html" title="docker secret rm"><span class="flex items-center gap-2">docker secret rm</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker service
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/index.html" title="docker service"><span class="flex items-center gap-2">docker service</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/create/index.html" title="docker service create"><span class="flex items-center gap-2">docker service create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/inspect/index.html" title="docker service inspect"><span class="flex items-center gap-2">docker service inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/logs/index.html" title="docker service logs"><span class="flex items-center gap-2">docker service logs</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/ls/index.html" title="docker service ls"><span class="flex items-center gap-2">docker service ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/ps/index.html" title="docker service ps"><span class="flex items-center gap-2">docker service ps</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/rollback/index.html" title="docker service rollback"><span class="flex items-center gap-2">docker service rollback</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/rm/index.html" title="docker service rm"><span class="flex items-center gap-2">docker service rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/scale/index.html" title="docker service scale"><span class="flex items-center gap-2">docker service scale</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/service/update/index.html" title="docker service update"><span class="flex items-center gap-2">docker service update</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker stack
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/index.html" title="docker stack"><span class="flex items-center gap-2">docker stack</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/config/index.html" title="docker stack config"><span class="flex items-center gap-2">docker stack config</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/deploy/index.html" title="docker stack deploy"><span class="flex items-center gap-2">docker stack deploy</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/ls/index.html" title="docker stack ls"><span class="flex items-center gap-2">docker stack ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/ps/index.html" title="docker stack ps"><span class="flex items-center gap-2">docker stack ps</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/rm/index.html" title="docker stack rm"><span class="flex items-center gap-2">docker stack rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/stack/services/index.html" title="docker stack services"><span class="flex items-center gap-2">docker stack services</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker swarm
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/index.html" title="docker swarm"><span class="flex items-center gap-2">docker swarm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/ca/index.html" title="docker swarm ca"><span class="flex items-center gap-2">docker swarm ca</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/init/index.html" title="docker swarm init"><span class="flex items-center gap-2">docker swarm init</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/join-token/index.html" title="docker swarm join-token"><span class="flex items-center gap-2">docker swarm join-token</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/join/index.html" title="docker swarm join"><span class="flex items-center gap-2">docker swarm join</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/leave/index.html" title="docker swarm leave"><span class="flex items-center gap-2">docker swarm leave</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/unlock-key/index.html" title="docker swarm unlock-key"><span class="flex items-center gap-2">docker swarm unlock-key</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/unlock/index.html" title="docker swarm unlock"><span class="flex items-center gap-2">docker swarm unlock</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/swarm/update/index.html" title="docker swarm update"><span class="flex items-center gap-2">docker swarm update</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker system
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/system/index.html" title="docker system"><span class="flex items-center gap-2">docker system</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/system/df/index.html" title="docker system df"><span class="flex items-center gap-2">docker system df</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/system/events/index.html" title="docker system events"><span class="flex items-center gap-2">docker system events</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/info/index.html" title="docker system info"><span class="flex items-center gap-2">docker system info</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/system/prune/index.html" title="docker system prune"><span class="flex items-center gap-2">docker system prune</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker trust
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/index.html" title="docker trust"><span class="flex items-center gap-2">docker trust</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/inspect/index.html" title="docker trust inspect"><span class="flex items-center gap-2">docker trust inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/key/index.html" title="docker trust key"><span class="flex items-center gap-2">docker trust key</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/key/generate/index.html" title="docker trust key generate"><span class="flex items-center gap-2">docker trust key generate</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/key/load/index.html" title="docker trust key load"><span class="flex items-center gap-2">docker trust key load</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/revoke/index.html" title="docker trust revoke"><span class="flex items-center gap-2">docker trust revoke</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/sign/index.html" title="docker trust sign"><span class="flex items-center gap-2">docker trust sign</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/signer/index.html" title="docker trust signer"><span class="flex items-center gap-2">docker trust signer</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/signer/add/index.html" title="docker trust signer add"><span class="flex items-center gap-2">docker trust signer add</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/trust/signer/remove/index.html" title="docker trust signer remove"><span class="flex items-center gap-2">docker trust signer remove</span></a></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/version/index.html" title="docker version"><span class="flex items-center gap-2">docker version</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">docker volume
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/volume/create/index.html" title="docker volume create"><span class="flex items-center gap-2">docker volume create</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/volume/inspect/index.html" title="docker volume inspect"><span class="flex items-center gap-2">docker volume inspect</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/volume/ls/index.html" title="docker volume ls"><span class="flex items-center gap-2">docker volume ls</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/volume/prune/index.html" title="docker volume prune"><span class="flex items-center gap-2">docker volume prune</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/volume/rm/index.html" title="docker volume rm"><span class="flex items-center gap-2">docker volume rm</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../reference/cli/docker/volume/update/index.html" title="docker volume update"><span class="flex items-center gap-2">docker volume update</span></a></li></ul></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../reference/builder/index.html" title="Dockerfile reference"><span class="flex items-center gap-2">Dockerfile reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../reference/commandline/dockerd/index.html" title="Daemon CLI (dockerd)"><span class="flex items-center gap-2">Daemon CLI (dockerd)</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">API reference
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="ml-3 md:ml-[21px]"><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">Docker Engine API
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../index.html" title=Overview><span class="flex items-center gap-2">Overview</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../sdk/index.html" title=SDKs><span class="flex items-center gap-2">SDKs</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../sdk/examples/index.html" title="SDK examples"><span class="flex items-center gap-2">SDK examples</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../latest/index.html" title="v1.44 reference (latest)"><span class="flex items-center gap-2">v1.44 reference (latest)</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">API reference by version
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../version-history/index.html" title="Version history overview"><span class="flex items-center gap-2">Version history overview</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.42/index.html" title="v1.42 reference"><span class="flex items-center gap-2">v1.42 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.41/index.html" title="v1.41 reference"><span class="flex items-center gap-2">v1.41 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.40/index.html" title="v1.40 reference"><span class="flex items-center gap-2">v1.40 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.39/index.html" title="v1.39 reference"><span class="flex items-center gap-2">v1.39 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.38/index.html" title="v1.38 reference"><span class="flex items-center gap-2">v1.38 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.37/index.html" title="v1.37 reference"><span class="flex items-center gap-2">v1.37 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.36/index.html" title="v1.36 reference"><span class="flex items-center gap-2">v1.36 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.35/index.html" title="v1.35 reference"><span class="flex items-center gap-2">v1.35 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.34/index.html" title="v1.34 reference"><span class="flex items-center gap-2">v1.34 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.33/index.html" title="v1.33 reference"><span class="flex items-center gap-2">v1.33 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.32/index.html" title="v1.32 Reference"><span class="flex items-center gap-2">v1.32 Reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.31/index.html" title="v1.31 Reference"><span class="flex items-center gap-2">v1.31 Reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.30/index.html" title="v1.30 Reference"><span class="flex items-center gap-2">v1.30 Reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.29/index.html" title="v1.29 Reference"><span class="flex items-center gap-2">v1.29 Reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.28/index.html" title="v1.28 reference"><span class="flex items-center gap-2">v1.28 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.27/index.html" title="v1.27 reference"><span class="flex items-center gap-2">v1.27 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.26/index.html" title="v1.26 reference"><span class="flex items-center gap-2">v1.26 reference</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../v1.25/index.html" title="v1.25 reference"><span class="flex items-center gap-2">v1.25 reference</span></a></li><li class="pl-4 sidebar-hover rounded
bg-gray-light-200 dark:bg-gray-dark-200"><a aria-current=page class="py-2 w-full truncate block" href="index.html" title="v1.24 reference"><span class="flex items-center gap-2">v1.24 reference</span></a></li></ul></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">Docker Hub API
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../docker-hub/api/latest/index.html" title="Docker Hub API"><span class="flex items-center gap-2">Docker Hub API</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../docker-hub/api/dvp/index.html" title="DVP Data API"><span class="flex items-center gap-2">DVP Data API</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../docker-hub/api/deprecated/index.html" title="Deprecated API"><span class="flex items-center gap-2">Deprecated API</span></a></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">Docker Extension SDK API
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/DesktopUI/index.html" title=DesktopUI><span class="flex items-center gap-2">DesktopUI</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/Dialog/index.html" title=Dialog><span class="flex items-center gap-2">Dialog</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/Docker/index.html" title=Docker><span class="flex items-center gap-2">Docker</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/DockerCommand/index.html" title=DockerCommand><span class="flex items-center gap-2">DockerCommand</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/DockerDesktopClient/index.html" title=DockerDesktopClient><span class="flex items-center gap-2">DockerDesktopClient</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/Exec/index.html" title=Exec><span class="flex items-center gap-2">Exec</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExecProcess/index.html" title=ExecProcess><span class="flex items-center gap-2">ExecProcess</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExecResult/index.html" title=ExecResult><span class="flex items-center gap-2">ExecResult</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExecStreamOptions/index.html" title=ExecStreamOptions><span class="flex items-center gap-2">ExecStreamOptions</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/Extension/index.html" title=Extension><span class="flex items-center gap-2">Extension</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionCli/index.html" title=ExtensionCli><span class="flex items-center gap-2">ExtensionCli</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionHost/index.html" title=ExtensionHost><span class="flex items-center gap-2">ExtensionHost</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExtensionVM/index.html" title=ExtensionVM><span class="flex items-center gap-2">ExtensionVM</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/Host/index.html" title=Host><span class="flex items-center gap-2">Host</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/HttpService/index.html" title=HttpService><span class="flex items-center gap-2">HttpService</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/NavigationIntents/index.html" title=NavigationIntents><span class="flex items-center gap-2">NavigationIntents</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/OpenDialogResult/index.html" title=OpenDialogResult><span class="flex items-center gap-2">OpenDialogResult</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/RawExecResult/index.html" title=RawExecResult><span class="flex items-center gap-2">RawExecResult</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfig/index.html" title=RequestConfig><span class="flex items-center gap-2">RequestConfig</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/RequestConfigV0/index.html" title=RequestConfigV0><span class="flex items-center gap-2">RequestConfigV0</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/Toast/index.html" title=Toast><span class="flex items-center gap-2">Toast</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/ExecResultV0/index.html" title=ExecResultV0><span class="flex items-center gap-2">ExecResultV0</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../desktop/extensions-sdk/dev/api/reference/interfaces/BackendV0/index.html" title=BackendV0><span class="flex items-center gap-2">BackendV0</span></a></li></ul></li></ul></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">Compose file reference
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">Compose Specification
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file.html" title=Overview><span class="flex items-center gap-2">Overview</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/04-version-and-name/index.html" title="Version and name top-level element"><span class="flex items-center gap-2">Version and name top-level element</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/05-services/index.html" title="Services top-level element"><span class="flex items-center gap-2">Services top-level element</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/06-networks/index.html" title="Network top-level element"><span class="flex items-center gap-2">Network top-level element</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/07-volumes/index.html" title="Volumes top-level element"><span class="flex items-center gap-2">Volumes top-level element</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/08-configs/index.html" title="Configs top-level element"><span class="flex items-center gap-2">Configs top-level element</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/09-secrets/index.html" title="Secrets top-level element"><span class="flex items-center gap-2">Secrets top-level element</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/10-fragments/index.html" title=Fragments><span class="flex items-center gap-2">Fragments</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/11-extension/index.html" title=Extensions><span class="flex items-center gap-2">Extensions</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/12-interpolation/index.html" title=Interpolation><span class="flex items-center gap-2">Interpolation</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/13-merge/index.html" title=Merge><span class="flex items-center gap-2">Merge</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/14-include/index.html" title=Include><span class="flex items-center gap-2">Include</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/15-profiles/index.html" title=Profiles><span class="flex items-center gap-2">Profiles</span></a></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/build/index.html" title="Compose Build Specification"><span class="flex items-center gap-2">Compose Build Specification</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/deploy/index.html" title="Compose Deploy Specification"><span class="flex items-center gap-2">Compose Deploy Specification</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/develop/index.html" title="Compose Develop Specification"><span class="flex items-center gap-2">Compose Develop Specification</span></a></li><li><button class="rounded px-4 sidebar-hover w-full flex items-center justify-between">
<span class="py-2 truncate flex items-center gap-2">Legacy versions
</span><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-357q-6 0-11-2t-10-7L261-564q-9-9-9-21t9-21 21.5-9 21.5 9l176 176 176-176q9-9 21-9t21 9 9 21.5-9 21.5L501-366q-5 5-10 7t-11 2z"/></svg>
</span><span class="icon-svg hidden"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M480-543 304-367q-9 9-21.5 9.5T261-366t-9-21.5 9-21.5l198-198q5-5 10-7t11-2 11 2 10 7l197 197q9 9 9.5 21t-8.5 21-21.5 9-21.5-9L480-543z"/></svg></span></button><ul class="hidden ml-3 md:ml-[21px]"><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/compose-versioning/index.html" title="About versions and upgrading"><span class="flex items-center gap-2">About versions and upgrading</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/compose-file-v3/index.html" title="Version 3"><span class="flex items-center gap-2">Version 3</span></a></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../compose/compose-file/compose-file-v2/index.html" title="Version 2"><span class="flex items-center gap-2">Version 2</span></a></li></ul></li></ul></li><li class="pl-4 sidebar-hover rounded"><a class="py-2 w-full truncate block" href="../../../glossary/index.html" title=Glossary><span class="flex items-center gap-2">Glossary</span></a></li></ul></nav></div><div class="w-[840px] flex-initial overflow-clip p-6 pt-0 md:w-lvw"><nav id=breadcrumbs class="py-4 gap-4 flex items-center text-gray-light dark:text-gray-dark max-w-full min-w-0"><a href="../../../app/working-with-app/index.html" class="link truncate">Reference</a><span>/</span><a "https://docs.docker.com/engine/api/v1.24/href" class="link truncate">API reference</a><span>/</span><a href="../index.html" class="link truncate">Docker Engine API</a><span>/</span><a href="../version-history/index.html" class="link truncate">API reference by version</a><span>/</span>
<span class=truncate>v1.24 reference</span></nav><article class="DocSearch-content prose max-w-none dark:prose-invert"><h1 class=scroll-mt-36>Engine API v1.24</h1><h2 class=scroll-mt-20 id=1-brief-introduction><a class="text-black dark:text-white no-underline hover:underline" href="index.html#1-brief-introduction">1. Brief introduction</a></h2><ul><li>The daemon listens on <code>unix:///var/run/docker.sock</code> but you can
<a class=link href="../../reference/commandline/dockerd/index.html#bind-docker-to-another-host-port-or-a-unix-socket" target=_blank rel=noopener>Bind Docker to another host/port or a Unix socket<span class="icon-svg icon-xs icon-top"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M180-120q-24 0-42-18t-18-42v-6e2q0-24 18-42t42-18h249q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T429-780H180v6e2h6e2v-249q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T840-429v249q0 24-18 42t-42 18H180zm6e2-617L403-360q-9 9-21 8.5t-21-9.5-9-21 9-21l377-377H549q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T549-840h291v291q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625-12.825.0-21.325-8.625T780-549v-188z"/></svg></span></a>.</li><li>The API tends to be REST. However, for some complex commands, like <code>attach</code>
or <code>pull</code>, the HTTP connection is hijacked to transport <code>stdout</code>,
<code>stdin</code> and <code>stderr</code>.</li><li>A <code>Content-Length</code> header should be present in <code>POST</code> requests to endpoints
that expect a body.</li><li>To lock to a specific version of the API, you prefix the URL with the version
of the API to use. For example, <code>/v1.18/info</code>. If no version is included in
the URL, the maximum supported API version is used.</li><li>If the API version specified in the URL is not supported by the daemon, a HTTP
<code>400 Bad Request</code> error message is returned.</li></ul><h2 class=scroll-mt-20 id=2-errors><a class="text-black dark:text-white no-underline hover:underline" href="index.html#2-errors">2. Errors</a></h2><p>The Engine API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:</p><pre><code>{
    &quot;message&quot;: &quot;page not found&quot;
}
</code></pre><p>The status codes that are returned for each endpoint are specified in the endpoint documentation below.</p><h2 class=scroll-mt-20 id=3-endpoints><a class="text-black dark:text-white no-underline hover:underline" href="index.html#3-endpoints">3. Endpoints</a></h2><h3 class=scroll-mt-20 id=31-containers><a class="text-black dark:text-white no-underline hover:underline" href="index.html#31-containers">3.1 Containers</a></h3><h4 class=scroll-mt-20 id=list-containers><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-containers">List containers</a></h4><p><code>GET /containers/json</code></p><p>List containers</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/json?all=1&amp;before=8dfafdbc3a40&amp;size=1 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
     {
             &quot;Id&quot;: &quot;8dfafdbc3a40&quot;,
             &quot;Names&quot;:[&quot;/boring_feynman&quot;],
             &quot;Image&quot;: &quot;ubuntu:latest&quot;,
             &quot;ImageID&quot;: &quot;d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82&quot;,
             &quot;Command&quot;: &quot;echo 1&quot;,
             &quot;Created&quot;: 1367854155,
             &quot;State&quot;: &quot;exited&quot;,
             &quot;Status&quot;: &quot;Exit 0&quot;,
             &quot;Ports&quot;: [{&quot;PrivatePort&quot;: 2222, &quot;PublicPort&quot;: 3333, &quot;Type&quot;: &quot;tcp&quot;}],
             &quot;Labels&quot;: {
                     &quot;com.example.vendor&quot;: &quot;Acme&quot;,
                     &quot;com.example.license&quot;: &quot;GPL&quot;,
                     &quot;com.example.version&quot;: &quot;1.0&quot;
             },
             &quot;SizeRw&quot;: 12288,
             &quot;SizeRootFs&quot;: 0,
             &quot;HostConfig&quot;: {
                     &quot;NetworkMode&quot;: &quot;default&quot;
             },
             &quot;NetworkSettings&quot;: {
                     &quot;Networks&quot;: {
                             &quot;bridge&quot;: {
                                      &quot;IPAMConfig&quot;: null,
                                      &quot;Links&quot;: null,
                                      &quot;Aliases&quot;: null,
                                      &quot;NetworkID&quot;: &quot;7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812&quot;,
                                      &quot;EndpointID&quot;: &quot;2cdc4edb1ded3631c81f57966563e5c8525b81121bb3706a9a9a3ae102711f3f&quot;,
                                      &quot;Gateway&quot;: &quot;172.17.0.1&quot;,
                                      &quot;IPAddress&quot;: &quot;172.17.0.2&quot;,
                                      &quot;IPPrefixLen&quot;: 16,
                                      &quot;IPv6Gateway&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6Address&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6PrefixLen&quot;: 0,
                                      &quot;MacAddress&quot;: &quot;02:42:ac:11:00:02&quot;
                              }
                     }
             },
             &quot;Mounts&quot;: [
                     {
                              &quot;Name&quot;: &quot;fac362...80535&quot;,
                              &quot;Source&quot;: &quot;/data&quot;,
                              &quot;Destination&quot;: &quot;/data&quot;,
                              &quot;Driver&quot;: &quot;local&quot;,
                              &quot;Mode&quot;: &quot;ro,Z&quot;,
                              &quot;RW&quot;: false,
                              &quot;Propagation&quot;: &quot;&quot;
                     }
             ]
     },
     {
             &quot;Id&quot;: &quot;9cd87474be90&quot;,
             &quot;Names&quot;:[&quot;/coolName&quot;],
             &quot;Image&quot;: &quot;ubuntu:latest&quot;,
             &quot;ImageID&quot;: &quot;d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82&quot;,
             &quot;Command&quot;: &quot;echo 222222&quot;,
             &quot;Created&quot;: 1367854155,
             &quot;State&quot;: &quot;exited&quot;,
             &quot;Status&quot;: &quot;Exit 0&quot;,
             &quot;Ports&quot;: [],
             &quot;Labels&quot;: {},
             &quot;SizeRw&quot;: 12288,
             &quot;SizeRootFs&quot;: 0,
             &quot;HostConfig&quot;: {
                     &quot;NetworkMode&quot;: &quot;default&quot;
             },
             &quot;NetworkSettings&quot;: {
                     &quot;Networks&quot;: {
                             &quot;bridge&quot;: {
                                      &quot;IPAMConfig&quot;: null,
                                      &quot;Links&quot;: null,
                                      &quot;Aliases&quot;: null,
                                      &quot;NetworkID&quot;: &quot;7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812&quot;,
                                      &quot;EndpointID&quot;: &quot;88eaed7b37b38c2a3f0c4bc796494fdf51b270c2d22656412a2ca5d559a64d7a&quot;,
                                      &quot;Gateway&quot;: &quot;172.17.0.1&quot;,
                                      &quot;IPAddress&quot;: &quot;172.17.0.8&quot;,
                                      &quot;IPPrefixLen&quot;: 16,
                                      &quot;IPv6Gateway&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6Address&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6PrefixLen&quot;: 0,
                                      &quot;MacAddress&quot;: &quot;02:42:ac:11:00:08&quot;
                              }
                     }
             },
             &quot;Mounts&quot;: []
     },
     {
             &quot;Id&quot;: &quot;3176a2479c92&quot;,
             &quot;Names&quot;:[&quot;/sleepy_dog&quot;],
             &quot;Image&quot;: &quot;ubuntu:latest&quot;,
             &quot;ImageID&quot;: &quot;d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82&quot;,
             &quot;Command&quot;: &quot;echo 3333333333333333&quot;,
             &quot;Created&quot;: 1367854154,
             &quot;State&quot;: &quot;exited&quot;,
             &quot;Status&quot;: &quot;Exit 0&quot;,
             &quot;Ports&quot;:[],
             &quot;Labels&quot;: {},
             &quot;SizeRw&quot;:12288,
             &quot;SizeRootFs&quot;:0,
             &quot;HostConfig&quot;: {
                     &quot;NetworkMode&quot;: &quot;default&quot;
             },
             &quot;NetworkSettings&quot;: {
                     &quot;Networks&quot;: {
                             &quot;bridge&quot;: {
                                      &quot;IPAMConfig&quot;: null,
                                      &quot;Links&quot;: null,
                                      &quot;Aliases&quot;: null,
                                      &quot;NetworkID&quot;: &quot;7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812&quot;,
                                      &quot;EndpointID&quot;: &quot;8b27c041c30326d59cd6e6f510d4f8d1d570a228466f956edf7815508f78e30d&quot;,
                                      &quot;Gateway&quot;: &quot;172.17.0.1&quot;,
                                      &quot;IPAddress&quot;: &quot;172.17.0.6&quot;,
                                      &quot;IPPrefixLen&quot;: 16,
                                      &quot;IPv6Gateway&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6Address&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6PrefixLen&quot;: 0,
                                      &quot;MacAddress&quot;: &quot;02:42:ac:11:00:06&quot;
                              }
                     }
             },
             &quot;Mounts&quot;: []
     },
     {
             &quot;Id&quot;: &quot;4cb07b47f9fb&quot;,
             &quot;Names&quot;:[&quot;/running_cat&quot;],
             &quot;Image&quot;: &quot;ubuntu:latest&quot;,
             &quot;ImageID&quot;: &quot;d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82&quot;,
             &quot;Command&quot;: &quot;echo 444444444444444444444444444444444&quot;,
             &quot;Created&quot;: 1367854152,
             &quot;State&quot;: &quot;exited&quot;,
             &quot;Status&quot;: &quot;Exit 0&quot;,
             &quot;Ports&quot;: [],
             &quot;Labels&quot;: {},
             &quot;SizeRw&quot;: 12288,
             &quot;SizeRootFs&quot;: 0,
             &quot;HostConfig&quot;: {
                     &quot;NetworkMode&quot;: &quot;default&quot;
             },
             &quot;NetworkSettings&quot;: {
                     &quot;Networks&quot;: {
                             &quot;bridge&quot;: {
                                      &quot;IPAMConfig&quot;: null,
                                      &quot;Links&quot;: null,
                                      &quot;Aliases&quot;: null,
                                      &quot;NetworkID&quot;: &quot;7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812&quot;,
                                      &quot;EndpointID&quot;: &quot;d91c7b2f0644403d7ef3095985ea0e2370325cd2332ff3a3225c4247328e66e9&quot;,
                                      &quot;Gateway&quot;: &quot;172.17.0.1&quot;,
                                      &quot;IPAddress&quot;: &quot;172.17.0.5&quot;,
                                      &quot;IPPrefixLen&quot;: 16,
                                      &quot;IPv6Gateway&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6Address&quot;: &quot;&quot;,
                                      &quot;GlobalIPv6PrefixLen&quot;: 0,
                                      &quot;MacAddress&quot;: &quot;02:42:ac:11:00:05&quot;
                              }
                     }
             },
             &quot;Mounts&quot;: []
     }
]
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>all</strong> – 1/True/true or 0/False/false, Show all containers.
Only running containers are shown by default (i.e., this defaults to false)</li><li><strong>limit</strong> – Show <code>limit</code> last created
containers, include non-running ones.</li><li><strong>since</strong> – Show only containers created since Id, include
non-running ones.</li><li><strong>before</strong> – Show only containers created before Id, include
non-running ones.</li><li><strong>size</strong> – 1/True/true or 0/False/false, Show the containers
sizes</li><li><strong>filters</strong> - a JSON encoded value of the filters (a <code>map[string][]string</code>) to process on the containers list. Available filters:</li><li><code>exited=&lt;int></code>; -- containers with exit code of <code>&lt;int></code> ;</li><li><code>status=</code>(<code>created</code>|<code>restarting</code>|<code>running</code>|<code>paused</code>|<code>exited</code>|<code>dead</code>)</li><li><code>label=key</code> or <code>label="key=value"</code> of a container label</li><li><code>isolation=</code>(<code>default</code>|<code>process</code>|<code>hyperv</code>) (Windows daemon only)</li><li><code>ancestor</code>=(<code>&lt;image-name>[:&lt;tag>]</code>, <code>&lt;image id></code> or <code>&lt;image@digest></code>)</li><li><code>before</code>=(<code>&lt;container id></code> or <code>&lt;container name></code>)</li><li><code>since</code>=(<code>&lt;container id></code> or <code>&lt;container name></code>)</li><li><code>volume</code>=(<code>&lt;volume name></code> or <code>&lt;mount point destination></code>)</li><li><code>network</code>=(<code>&lt;network id></code> or <code>&lt;network name></code>)</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=create-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#create-a-container">Create a container</a></h4><p><code>POST /containers/create</code></p><p>Create a container</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/create HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
       &quot;Hostname&quot;: &quot;&quot;,
       &quot;Domainname&quot;: &quot;&quot;,
       &quot;User&quot;: &quot;&quot;,
       &quot;AttachStdin&quot;: false,
       &quot;AttachStdout&quot;: true,
       &quot;AttachStderr&quot;: true,
       &quot;Tty&quot;: false,
       &quot;OpenStdin&quot;: false,
       &quot;StdinOnce&quot;: false,
       &quot;Env&quot;: [
               &quot;FOO=bar&quot;,
               &quot;BAZ=quux&quot;
       ],
       &quot;Cmd&quot;: [
               &quot;date&quot;
       ],
       &quot;Entrypoint&quot;: &quot;&quot;,
       &quot;Image&quot;: &quot;ubuntu&quot;,
       &quot;Labels&quot;: {
               &quot;com.example.vendor&quot;: &quot;Acme&quot;,
               &quot;com.example.license&quot;: &quot;GPL&quot;,
               &quot;com.example.version&quot;: &quot;1.0&quot;
       },
       &quot;Volumes&quot;: {
         &quot;/volumes/data&quot;: {}
       },
       &quot;Healthcheck&quot;:{
          &quot;Test&quot;: [&quot;CMD-SHELL&quot;, &quot;curl localhost:3000&quot;],
          &quot;Interval&quot;: 1000000000,
          &quot;Timeout&quot;: 10000000000,
          &quot;Retries&quot;: 10,
          &quot;StartPeriod&quot;: 60000000000
       },
       &quot;WorkingDir&quot;: &quot;&quot;,
       &quot;NetworkDisabled&quot;: false,
       &quot;MacAddress&quot;: &quot;12:34:56:78:9a:bc&quot;,
       &quot;ExposedPorts&quot;: {
               &quot;22/tcp&quot;: {}
       },
       &quot;StopSignal&quot;: &quot;SIGTERM&quot;,
       &quot;HostConfig&quot;: {
         &quot;Binds&quot;: [&quot;/tmp:/tmp&quot;],
         &quot;Tmpfs&quot;: { &quot;/run&quot;: &quot;rw,noexec,nosuid,size=65536k&quot; },
         &quot;Links&quot;: [&quot;redis3:redis&quot;],
         &quot;Memory&quot;: 0,
         &quot;MemorySwap&quot;: 0,
         &quot;MemoryReservation&quot;: 0,
         &quot;KernelMemory&quot;: 0,
         &quot;CpuPercent&quot;: 80,
         &quot;CpuShares&quot;: 512,
         &quot;CpuPeriod&quot;: 100000,
         &quot;CpuQuota&quot;: 50000,
         &quot;CpusetCpus&quot;: &quot;0,1&quot;,
         &quot;CpusetMems&quot;: &quot;0,1&quot;,
         &quot;IOMaximumBandwidth&quot;: 0,
         &quot;IOMaximumIOps&quot;: 0,
         &quot;BlkioWeight&quot;: 300,
         &quot;BlkioWeightDevice&quot;: [{}],
         &quot;BlkioDeviceReadBps&quot;: [{}],
         &quot;BlkioDeviceReadIOps&quot;: [{}],
         &quot;BlkioDeviceWriteBps&quot;: [{}],
         &quot;BlkioDeviceWriteIOps&quot;: [{}],
         &quot;MemorySwappiness&quot;: 60,
         &quot;OomKillDisable&quot;: false,
         &quot;OomScoreAdj&quot;: 500,
         &quot;PidMode&quot;: &quot;&quot;,
         &quot;PidsLimit&quot;: -1,
         &quot;PortBindings&quot;: { &quot;22/tcp&quot;: [{ &quot;HostPort&quot;: &quot;11022&quot; }] },
         &quot;PublishAllPorts&quot;: false,
         &quot;Privileged&quot;: false,
         &quot;ReadonlyRootfs&quot;: false,
         &quot;Dns&quot;: [&quot;8.8.8.8&quot;],
         &quot;DnsOptions&quot;: [&quot;&quot;],
         &quot;DnsSearch&quot;: [&quot;&quot;],
         &quot;ExtraHosts&quot;: null,
         &quot;VolumesFrom&quot;: [&quot;parent&quot;, &quot;other:ro&quot;],
         &quot;CapAdd&quot;: [&quot;NET_ADMIN&quot;],
         &quot;CapDrop&quot;: [&quot;MKNOD&quot;],
         &quot;GroupAdd&quot;: [&quot;newgroup&quot;],
         &quot;RestartPolicy&quot;: { &quot;Name&quot;: &quot;&quot;, &quot;MaximumRetryCount&quot;: 0 },
         &quot;NetworkMode&quot;: &quot;bridge&quot;,
         &quot;Devices&quot;: [],
         &quot;Sysctls&quot;: { &quot;net.ipv4.ip_forward&quot;: &quot;1&quot; },
         &quot;Ulimits&quot;: [{}],
         &quot;LogConfig&quot;: { &quot;Type&quot;: &quot;json-file&quot;, &quot;Config&quot;: {} },
         &quot;SecurityOpt&quot;: [],
         &quot;StorageOpt&quot;: {},
         &quot;CgroupParent&quot;: &quot;&quot;,
         &quot;VolumeDriver&quot;: &quot;&quot;,
         &quot;ShmSize&quot;: 67108864
      },
      &quot;NetworkingConfig&quot;: {
          &quot;EndpointsConfig&quot;: {
              &quot;isolated_nw&quot; : {
                  &quot;IPAMConfig&quot;: {
                      &quot;IPv4Address&quot;:&quot;172.20.30.33&quot;,
                      &quot;IPv6Address&quot;:&quot;2001:db8:abcd::3033&quot;,
                      &quot;LinkLocalIPs&quot;:[&quot;169.254.34.68&quot;, &quot;fe80::3468&quot;]
                  },
                  &quot;Links&quot;:[&quot;container_1&quot;, &quot;container_2&quot;],
                  &quot;Aliases&quot;:[&quot;server_x&quot;, &quot;server_y&quot;]
              }
          }
      }
  }
</code></pre><p><strong>Example response</strong>:</p><pre><code>  HTTP/1.1 201 Created
  Content-Type: application/json

  {
       &quot;Id&quot;:&quot;e90e34656806&quot;,
       &quot;Warnings&quot;:[]
  }
</code></pre><p><strong>JSON parameters</strong>:</p><ul><li><strong>Hostname</strong> - A string value containing the hostname to use for the
container. This must be a valid RFC 1123 hostname.</li><li><strong>Domainname</strong> - A string value containing the domain name to use
for the container.</li><li><strong>User</strong> - A string value specifying the user inside the container.</li><li><strong>AttachStdin</strong> - Boolean value, attaches to <code>stdin</code>.</li><li><strong>AttachStdout</strong> - Boolean value, attaches to <code>stdout</code>.</li><li><strong>AttachStderr</strong> - Boolean value, attaches to <code>stderr</code>.</li><li><strong>Tty</strong> - Boolean value, Attach standard streams to a <code>tty</code>, including <code>stdin</code> if it is not closed.</li><li><strong>OpenStdin</strong> - Boolean value, opens <code>stdin</code>,</li><li><strong>StdinOnce</strong> - Boolean value, close <code>stdin</code> after the 1 attached client disconnects.</li><li><strong>Env</strong> - A list of environment variables in the form of <code>["VAR=value", ...]</code></li><li><strong>Labels</strong> - Adds a map of labels to a container. To specify a map: <code>{"key":"value", ... }</code></li><li><strong>Cmd</strong> - Command to run specified as a string or an array of strings.</li><li><strong>Entrypoint</strong> - Set the entry point for the container as a string or an array
of strings.</li><li><strong>Image</strong> - A string specifying the image name to use for the container.</li><li><strong>Volumes</strong> - An object mapping mount point paths (strings) inside the
container to empty objects.</li><li><strong>Healthcheck</strong> - A test to perform to check that the container is healthy.<ul><li><pre><code>**Test** - The test to perform. Possible values are:
    + `{}` inherit healthcheck from image or parent image
    + `{&quot;NONE&quot;}` disable healthcheck
    + `{&quot;CMD&quot;, args...}` exec arguments directly
    + `{&quot;CMD-SHELL&quot;, command}` run command with system's default shell
</code></pre></li><li><pre><code>**Interval** - The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
</code></pre></li><li><pre><code>**Timeout** - The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
</code></pre></li><li><pre><code>**Retries** - The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
</code></pre></li><li><pre><code>**StartPeriod** - The time to wait for container initialization before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
</code></pre></li></ul></li><li><strong>WorkingDir</strong> - A string specifying the working directory for commands to
run in.</li><li><strong>NetworkDisabled</strong> - Boolean value, when true disables networking for the
container</li><li><strong>ExposedPorts</strong> - An object mapping ports to an empty object in the form of:
<code>"ExposedPorts": { "&lt;port>/&lt;tcp|udp>: {}" }</code></li><li><strong>StopSignal</strong> - Signal to stop a container as a string or unsigned integer. <code>SIGTERM</code> by default.</li><li><strong>HostConfig</strong><ul><li><p><strong>Binds</strong> – A list of volume bindings for this container. Each volume binding is a string in one of these forms:</p><ul><li><code>host-src:container-dest</code> to bind-mount a host path into the
container. Both <code>host-src</code>, and <code>container-dest</code> must be an
<em>absolute</em> path.</li><li><code>host-src:container-dest:ro</code> to make the bind mount read-only
inside the container. Both <code>host-src</code>, and <code>container-dest</code> must be
an <em>absolute</em> path.</li><li><code>volume-name:container-dest</code> to bind-mount a volume managed by a
volume driver into the container. <code>container-dest</code> must be an
<em>absolute</em> path.</li><li><code>volume-name:container-dest:ro</code> to mount the volume read-only
inside the container. <code>container-dest</code> must be an <em>absolute</em> path.</li></ul></li><li><p><strong>Tmpfs</strong> – A map of container directories which should be replaced by tmpfs mounts, and their corresponding
mount options. A JSON object in the form <code>{ "/run": "rw,noexec,nosuid,size=65536k" }</code>.</p></li><li><p><strong>Links</strong> - A list of links for the container. Each link entry should be
in the form of <code>container_name:alias</code>.</p></li><li><p><strong>Memory</strong> - Memory limit in bytes.</p></li><li><p><strong>MemorySwap</strong> - Total memory limit (memory + swap); set <code>-1</code> to enable unlimited swap.
You must use this with <code>memory</code> and make the swap value larger than <code>memory</code>.</p></li><li><p><strong>MemoryReservation</strong> - Memory soft limit in bytes.</p></li><li><p><strong>KernelMemory</strong> - Kernel memory limit in bytes.</p></li><li><p><strong>CpuPercent</strong> - An integer value containing the usable percentage of the available CPUs. (Windows daemon only)</p></li><li><p><strong>CpuShares</strong> - An integer value containing the container's CPU Shares
(ie. the relative weight vs other containers).</p></li><li><p><strong>CpuPeriod</strong> - The length of a CPU period in microseconds.</p></li><li><p><strong>CpuQuota</strong> - Microseconds of CPU time that the container can get in a CPU period.</p></li><li><p><strong>CpusetCpus</strong> - String value containing the <code>cgroups CpusetCpus</code> to use.</p></li><li><p><strong>CpusetMems</strong> - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.</p></li><li><p><strong>IOMaximumBandwidth</strong> - Maximum IO absolute rate in terms of IOps.</p></li><li><p><strong>IOMaximumIOps</strong> - Maximum IO absolute rate in terms of bytes per second.</p></li><li><p><strong>BlkioWeight</strong> - Block IO weight (relative weight) accepts a weight value between 10 and 1000.</p></li><li><p><strong>BlkioWeightDevice</strong> - Block IO weight (relative device weight) in the form of: <code>"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]</code></p></li><li><p><strong>BlkioDeviceReadBps</strong> - Limit read rate (bytes per second) from a device in the form of: <code>"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]</code>, for example:
<code>"BlkioDeviceReadBps": [{"Path": "/dev/sda", "Rate": "1024"}]"</code></p></li><li><p><strong>BlkioDeviceWriteBps</strong> - Limit write rate (bytes per second) to a device in the form of: <code>"BlkioDeviceWriteBps": [{"Path": "device_path", "Rate": rate}]</code>, for example:
<code>"BlkioDeviceWriteBps": [{"Path": "/dev/sda", "Rate": "1024"}]"</code></p></li><li><p><strong>BlkioDeviceReadIOps</strong> - Limit read rate (IO per second) from a device in the form of: <code>"BlkioDeviceReadIOps": [{"Path": "device_path", "Rate": rate}]</code>, for example:
<code>"BlkioDeviceReadIOps": [{"Path": "/dev/sda", "Rate": "1000"}]</code></p></li><li><p><strong>BlkioDeviceWriteIOps</strong> - Limit write rate (IO per second) to a device in the form of: <code>"BlkioDeviceWriteIOps": [{"Path": "device_path", "Rate": rate}]</code>, for example:
<code>"BlkioDeviceWriteIOps": [{"Path": "/dev/sda", "Rate": "1000"}]</code></p></li><li><p><strong>MemorySwappiness</strong> - Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.</p></li><li><p><strong>OomKillDisable</strong> - Boolean value, whether to disable OOM Killer for the container or not.</p></li><li><p><strong>OomScoreAdj</strong> - An integer value containing the score given to the container in order to tune OOM killer preferences.</p></li><li><p><strong>PidMode</strong> - Set the PID (Process) Namespace mode for the container;
<code>"container:&lt;name|id>"</code>: joins another container's PID namespace
<code>"host"</code>: use the host's PID namespace inside the container</p></li><li><p><strong>PidsLimit</strong> - Tune a container's pids limit. Set -1 for unlimited.</p></li><li><p><strong>PortBindings</strong> - A map of exposed container ports and the host port they
should map to. A JSON object in the form
<code>{ &lt;port>/&lt;protocol>: [{ "HostPort": "&lt;port>" }] }</code>
Take note that <code>port</code> is specified as a string and not an integer value.</p></li><li><p><strong>PublishAllPorts</strong> - Allocates an ephemeral host port for all of a container's
exposed ports. Specified as a boolean value.</p><p>Ports are de-allocated when the container stops and allocated when the container starts.
The allocated port might be changed when restarting the container.</p><p>The port is selected from the ephemeral port range that depends on the kernel.
For example, on Linux the range is defined by <code>/proc/sys/net/ipv4/ip_local_port_range</code>.</p></li><li><p><strong>Privileged</strong> - Gives the container full access to the host. Specified as
a boolean value.</p></li><li><p><strong>ReadonlyRootfs</strong> - Mount the container's root filesystem as read only.
Specified as a boolean value.</p></li><li><p><strong>Dns</strong> - A list of DNS servers for the container to use.</p></li><li><p><strong>DnsOptions</strong> - A list of DNS options</p></li><li><p><strong>DnsSearch</strong> - A list of DNS search domains</p></li><li><p><strong>ExtraHosts</strong> - A list of hostnames/IP mappings to add to the
container's <code>/etc/hosts</code> file. Specified in the form <code>["hostname:IP"]</code>.</p></li><li><p><strong>VolumesFrom</strong> - A list of volumes to inherit from another container.
Specified in the form <code>&lt;container name>[:&lt;ro|rw>]</code></p></li><li><p><strong>CapAdd</strong> - A list of kernel capabilities to add to the container.</p></li><li><p><strong>Capdrop</strong> - A list of kernel capabilities to drop from the container.</p></li><li><p><strong>GroupAdd</strong> - A list of additional groups that the container process will run as</p></li><li><p><strong>RestartPolicy</strong> – The behavior to apply when the container exits. The
value is an object with a <code>Name</code> property of either <code>"always"</code> to
always restart, <code>"unless-stopped"</code> to restart always except when
user has manually stopped the container or <code>"on-failure"</code> to restart only when the container
exit code is non-zero. If <code>on-failure</code> is used, <code>MaximumRetryCount</code>
controls the number of times to retry before giving up.
The default is not to restart. (optional)
An ever increasing delay (double the previous delay, starting at 100mS)
is added before each restart to prevent flooding the server.</p></li><li><p><strong>UsernsMode</strong> - Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
supported values are: <code>host</code>.</p></li><li><p><strong>NetworkMode</strong> - Sets the networking mode for the container. Supported
standard values are: <code>bridge</code>, <code>host</code>, <code>none</code>, and <code>container:&lt;name|id></code>. Any other value is taken
as a custom network's name to which this container should connect to.</p></li><li><p><strong>Devices</strong> - A list of devices to add to the container specified as a JSON object in the
form
<code>{ "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw"}</code></p></li><li><p><strong>Ulimits</strong> - A list of ulimits to set in the container, specified as
<code>{ "Name": &lt;name>, "Soft": &lt;soft limit>, "Hard": &lt;hard limit> }</code>, for example:
<code>Ulimits: { "Name": "nofile", "Soft": 1024, "Hard": 2048 }</code></p></li><li><p><strong>Sysctls</strong> - A list of kernel parameters (sysctls) to set in the container, specified as
<code>{ &lt;name>: &lt;Value> }</code>, for example:
<code>{ "net.ipv4.ip_forward": "1" }</code></p></li><li><p><strong>SecurityOpt</strong>: A list of string values to customize labels for MLS
systems, such as SELinux.</p></li><li><p><strong>StorageOpt</strong>: Storage driver options per container. Options can be passed in the form
<code>{"size":"120G"}</code></p></li><li><p><strong>LogConfig</strong> - Log configuration for the container, specified as a JSON object in the form
<code>{ "Type": "&lt;driver_name>", "Config": {"key1": "val1"}}</code>.
Available types: <code>json-file</code>, <code>syslog</code>, <code>journald</code>, <code>gelf</code>, <code>fluentd</code>, <code>awslogs</code>, <code>splunk</code>, <code>etwlogs</code>, <code>none</code>.
<code>json-file</code> logging driver.</p></li><li><p><strong>CgroupParent</strong> - Path to <code>cgroups</code> under which the container's <code>cgroup</code> is created. If the path is not absolute, the path is considered to be relative to the <code>cgroups</code> path of the init process. Cgroups are created if they do not already exist.</p></li><li><p><strong>VolumeDriver</strong> - Driver that this container users to mount volumes.</p></li><li><p><strong>ShmSize</strong> - Size of <code>/dev/shm</code> in bytes. The size must be greater than 0. If omitted the system uses 64MB.</p></li></ul></li></ul><p><strong>Query parameters</strong>:</p><ul><li><strong>name</strong> – Assign the specified name to the container. Must
match <code>/?[a-zA-Z0-9_-]+</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>404</strong> – no such image</li><li><strong>406</strong> – impossible to attach (container not running)</li><li><strong>409</strong> – conflict</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=inspect-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-a-container">Inspect a container</a></h4><p><code>GET /containers/(id or name)/json</code></p><p>Return low-level information on the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>  GET /v1.24/containers/4fa6e0f0c678/json HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
	&quot;AppArmorProfile&quot;: &quot;&quot;,
	&quot;Args&quot;: [
		&quot;-c&quot;,
		&quot;exit 9&quot;
	],
	&quot;Config&quot;: {
		&quot;AttachStderr&quot;: true,
		&quot;AttachStdin&quot;: false,
		&quot;AttachStdout&quot;: true,
		&quot;Cmd&quot;: [
			&quot;/bin/sh&quot;,
			&quot;-c&quot;,
			&quot;exit 9&quot;
		],
		&quot;Domainname&quot;: &quot;&quot;,
		&quot;Entrypoint&quot;: null,
		&quot;Env&quot;: [
			&quot;PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin&quot;
		],
		&quot;ExposedPorts&quot;: null,
		&quot;Hostname&quot;: &quot;ba033ac44011&quot;,
		&quot;Image&quot;: &quot;ubuntu&quot;,
		&quot;Labels&quot;: {
			&quot;com.example.vendor&quot;: &quot;Acme&quot;,
			&quot;com.example.license&quot;: &quot;GPL&quot;,
			&quot;com.example.version&quot;: &quot;1.0&quot;
		},
		&quot;MacAddress&quot;: &quot;&quot;,
		&quot;NetworkDisabled&quot;: false,
		&quot;OnBuild&quot;: null,
		&quot;OpenStdin&quot;: false,
		&quot;StdinOnce&quot;: false,
		&quot;Tty&quot;: false,
		&quot;User&quot;: &quot;&quot;,
		&quot;Volumes&quot;: {
			&quot;/volumes/data&quot;: {}
		},
		&quot;WorkingDir&quot;: &quot;&quot;,
		&quot;StopSignal&quot;: &quot;SIGTERM&quot;
	},
	&quot;Created&quot;: &quot;2015-01-06T15:47:31.485331387Z&quot;,
	&quot;Driver&quot;: &quot;overlay2&quot;,
	&quot;ExecIDs&quot;: null,
	&quot;HostConfig&quot;: {
		&quot;Binds&quot;: null,
		&quot;IOMaximumBandwidth&quot;: 0,
		&quot;IOMaximumIOps&quot;: 0,
		&quot;BlkioWeight&quot;: 0,
		&quot;BlkioWeightDevice&quot;: [{}],
		&quot;BlkioDeviceReadBps&quot;: [{}],
		&quot;BlkioDeviceWriteBps&quot;: [{}],
		&quot;BlkioDeviceReadIOps&quot;: [{}],
		&quot;BlkioDeviceWriteIOps&quot;: [{}],
		&quot;CapAdd&quot;: null,
		&quot;CapDrop&quot;: null,
		&quot;ContainerIDFile&quot;: &quot;&quot;,
		&quot;CpusetCpus&quot;: &quot;&quot;,
		&quot;CpusetMems&quot;: &quot;&quot;,
		&quot;CpuPercent&quot;: 80,
		&quot;CpuShares&quot;: 0,
		&quot;CpuPeriod&quot;: 100000,
		&quot;Devices&quot;: [],
		&quot;Dns&quot;: null,
		&quot;DnsOptions&quot;: null,
		&quot;DnsSearch&quot;: null,
		&quot;ExtraHosts&quot;: null,
		&quot;IpcMode&quot;: &quot;&quot;,
		&quot;Links&quot;: null,
		&quot;Memory&quot;: 0,
		&quot;MemorySwap&quot;: 0,
		&quot;MemoryReservation&quot;: 0,
		&quot;KernelMemory&quot;: 0,
		&quot;OomKillDisable&quot;: false,
		&quot;OomScoreAdj&quot;: 500,
		&quot;NetworkMode&quot;: &quot;bridge&quot;,
		&quot;PidMode&quot;: &quot;&quot;,
		&quot;PortBindings&quot;: {},
		&quot;Privileged&quot;: false,
		&quot;ReadonlyRootfs&quot;: false,
		&quot;PublishAllPorts&quot;: false,
		&quot;RestartPolicy&quot;: {
			&quot;MaximumRetryCount&quot;: 2,
			&quot;Name&quot;: &quot;on-failure&quot;
		},
		&quot;LogConfig&quot;: {
			&quot;Config&quot;: null,
			&quot;Type&quot;: &quot;json-file&quot;
		},
		&quot;SecurityOpt&quot;: null,
		&quot;Sysctls&quot;: {
		        &quot;net.ipv4.ip_forward&quot;: &quot;1&quot;
		},
		&quot;StorageOpt&quot;: null,
		&quot;VolumesFrom&quot;: null,
		&quot;Ulimits&quot;: [{}],
		&quot;VolumeDriver&quot;: &quot;&quot;,
		&quot;ShmSize&quot;: 67108864
	},
	&quot;HostnamePath&quot;: &quot;/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hostname&quot;,
	&quot;HostsPath&quot;: &quot;/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/hosts&quot;,
	&quot;LogPath&quot;: &quot;/var/lib/docker/containers/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b/1eb5fabf5a03807136561b3c00adcd2992b535d624d5e18b6cdc6a6844d9767b-json.log&quot;,
	&quot;Id&quot;: &quot;ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39&quot;,
	&quot;Image&quot;: &quot;04c5d3b7b0656168630d3ba35d8889bd0e9caafcaeb3004d2bfbc47e7c5d35d2&quot;,
	&quot;MountLabel&quot;: &quot;&quot;,
	&quot;Name&quot;: &quot;/boring_euclid&quot;,
	&quot;NetworkSettings&quot;: {
		&quot;Bridge&quot;: &quot;&quot;,
		&quot;SandboxID&quot;: &quot;&quot;,
		&quot;HairpinMode&quot;: false,
		&quot;LinkLocalIPv6Address&quot;: &quot;&quot;,
		&quot;LinkLocalIPv6PrefixLen&quot;: 0,
		&quot;Ports&quot;: null,
		&quot;SandboxKey&quot;: &quot;&quot;,
		&quot;SecondaryIPAddresses&quot;: null,
		&quot;SecondaryIPv6Addresses&quot;: null,
		&quot;EndpointID&quot;: &quot;&quot;,
		&quot;Gateway&quot;: &quot;&quot;,
		&quot;GlobalIPv6Address&quot;: &quot;&quot;,
		&quot;GlobalIPv6PrefixLen&quot;: 0,
		&quot;IPAddress&quot;: &quot;&quot;,
		&quot;IPPrefixLen&quot;: 0,
		&quot;IPv6Gateway&quot;: &quot;&quot;,
		&quot;MacAddress&quot;: &quot;&quot;,
		&quot;Networks&quot;: {
			&quot;bridge&quot;: {
				&quot;NetworkID&quot;: &quot;7ea29fc1412292a2d7bba362f9253545fecdfa8ce9a6e37dd10ba8bee7129812&quot;,
				&quot;EndpointID&quot;: &quot;7587b82f0dada3656fda26588aee72630c6fab1536d36e394b2bfbcf898c971d&quot;,
				&quot;Gateway&quot;: &quot;172.17.0.1&quot;,
				&quot;IPAddress&quot;: &quot;172.17.0.2&quot;,
				&quot;IPPrefixLen&quot;: 16,
				&quot;IPv6Gateway&quot;: &quot;&quot;,
				&quot;GlobalIPv6Address&quot;: &quot;&quot;,
				&quot;GlobalIPv6PrefixLen&quot;: 0,
				&quot;MacAddress&quot;: &quot;02:42:ac:12:00:02&quot;
			}
		}
	},
	&quot;Path&quot;: &quot;/bin/sh&quot;,
	&quot;ProcessLabel&quot;: &quot;&quot;,
	&quot;ResolvConfPath&quot;: &quot;/var/lib/docker/containers/ba033ac4401106a3b513bc9d639eee123ad78ca3616b921167cd74b20e25ed39/resolv.conf&quot;,
	&quot;RestartCount&quot;: 1,
	&quot;State&quot;: {
		&quot;Error&quot;: &quot;&quot;,
		&quot;ExitCode&quot;: 9,
		&quot;FinishedAt&quot;: &quot;2015-01-06T15:47:32.080254511Z&quot;,
		&quot;OOMKilled&quot;: false,
		&quot;Dead&quot;: false,
		&quot;Paused&quot;: false,
		&quot;Pid&quot;: 0,
		&quot;Restarting&quot;: false,
		&quot;Running&quot;: true,
		&quot;StartedAt&quot;: &quot;2015-01-06T15:47:32.072697474Z&quot;,
		&quot;Status&quot;: &quot;running&quot;
	},
	&quot;Mounts&quot;: [
		{
			&quot;Name&quot;: &quot;fac362...80535&quot;,
			&quot;Source&quot;: &quot;/data&quot;,
			&quot;Destination&quot;: &quot;/data&quot;,
			&quot;Driver&quot;: &quot;local&quot;,
			&quot;Mode&quot;: &quot;ro,Z&quot;,
			&quot;RW&quot;: false,
			&quot;Propagation&quot;: &quot;&quot;
		}
	]
}
</code></pre><p><strong>Example request, with size information</strong>:</p><pre><code>GET /v1.24/containers/4fa6e0f0c678/json?size=1 HTTP/1.1
</code></pre><p><strong>Example response, with size information</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
....
&quot;SizeRw&quot;: 0,
&quot;SizeRootFs&quot;: 972,
....
}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>size</strong> – 1/True/true or 0/False/false, return container size information. Default is <code>false</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=list-processes-running-inside-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-processes-running-inside-a-container">List processes running inside a container</a></h4><p><code>GET /containers/(id or name)/top</code></p><p>List processes running inside the container <code>id</code>. On Unix systems this
is done by running the <code>ps</code> command. This endpoint is not
supported on Windows.</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/4fa6e0f0c678/top HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
   &quot;Titles&quot; : [
     &quot;UID&quot;, &quot;PID&quot;, &quot;PPID&quot;, &quot;C&quot;, &quot;STIME&quot;, &quot;TTY&quot;, &quot;TIME&quot;, &quot;CMD&quot;
   ],
   &quot;Processes&quot; : [
     [
       &quot;root&quot;, &quot;13642&quot;, &quot;882&quot;, &quot;0&quot;, &quot;17:03&quot;, &quot;pts/0&quot;, &quot;00:00:00&quot;, &quot;/bin/bash&quot;
     ],
     [
       &quot;root&quot;, &quot;13735&quot;, &quot;13642&quot;, &quot;0&quot;, &quot;17:06&quot;, &quot;pts/0&quot;, &quot;00:00:00&quot;, &quot;sleep 10&quot;
     ]
   ]
}
</code></pre><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/4fa6e0f0c678/top?ps_args=aux HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &quot;Titles&quot; : [
    &quot;USER&quot;,&quot;PID&quot;,&quot;%CPU&quot;,&quot;%MEM&quot;,&quot;VSZ&quot;,&quot;RSS&quot;,&quot;TTY&quot;,&quot;STAT&quot;,&quot;START&quot;,&quot;TIME&quot;,&quot;COMMAND&quot;
  ]
  &quot;Processes&quot; : [
    [
      &quot;root&quot;,&quot;13642&quot;,&quot;0.0&quot;,&quot;0.1&quot;,&quot;18172&quot;,&quot;3184&quot;,&quot;pts/0&quot;,&quot;Ss&quot;,&quot;17:03&quot;,&quot;0:00&quot;,&quot;/bin/bash&quot;
    ],
    [
      &quot;root&quot;,&quot;13895&quot;,&quot;0.0&quot;,&quot;0.0&quot;,&quot;4348&quot;,&quot;692&quot;,&quot;pts/0&quot;,&quot;S+&quot;,&quot;17:15&quot;,&quot;0:00&quot;,&quot;sleep 10&quot;
    ]
  ],
}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>ps_args</strong> – <code>ps</code> arguments to use (e.g., <code>aux</code>), defaults to <code>-ef</code></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=get-container-logs><a class="text-black dark:text-white no-underline hover:underline" href="index.html#get-container-logs">Get container logs</a></h4><p><code>GET /containers/(id or name)/logs</code></p><p>Get <code>stdout</code> and <code>stderr</code> logs from the container <code>id</code></p><blockquote><p><strong>Note</strong>:
This endpoint works only for containers with the <code>json-file</code> or <code>journald</code> logging drivers.</p></blockquote><p><strong>Example request</strong>:</p><pre><code> GET /v1.24/containers/4fa6e0f0c678/logs?stderr=1&amp;stdout=1&amp;timestamps=1&amp;follow=1&amp;tail=10&amp;since=1428990821 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code> HTTP/1.1 101 UPGRADED
 Content-Type: application/vnd.docker.raw-stream
 Connection: Upgrade
 Upgrade: tcp

 {% raw %}
 {{ STREAM }}
 {% endraw %}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>details</strong> - 1/True/true or 0/False/false, Show extra details provided to logs. Default <code>false</code>.</li><li><strong>follow</strong> – 1/True/true or 0/False/false, return stream. Default <code>false</code>.</li><li><strong>stdout</strong> – 1/True/true or 0/False/false, show <code>stdout</code> log. Default <code>false</code>.</li><li><strong>stderr</strong> – 1/True/true or 0/False/false, show <code>stderr</code> log. Default <code>false</code>.</li><li><strong>since</strong> – UNIX timestamp (integer) to filter logs. Specifying a timestamp
will only output log-entries since that timestamp. Default: 0 (unfiltered)</li><li><strong>timestamps</strong> – 1/True/true or 0/False/false, print timestamps for
every log line. Default <code>false</code>.</li><li><strong>tail</strong> – Output specified number of lines at the end of logs: <code>all</code> or <code>&lt;number></code>. Default all.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>101</strong> – no error, hints proxy about hijacking</li><li><strong>200</strong> – no error, no upgrade header found</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=inspect-changes-on-a-containers-filesystem><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-changes-on-a-containers-filesystem">Inspect changes on a container's filesystem</a></h4><p><code>GET /containers/(id or name)/changes</code></p><p>Inspect changes on container <code>id</code>'s filesystem</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/4fa6e0f0c678/changes HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
     {
             &quot;Path&quot;: &quot;/dev&quot;,
             &quot;Kind&quot;: 0
     },
     {
             &quot;Path&quot;: &quot;/dev/kmsg&quot;,
             &quot;Kind&quot;: 1
     },
     {
             &quot;Path&quot;: &quot;/test&quot;,
             &quot;Kind&quot;: 1
     }
]
</code></pre><p>Values for <code>Kind</code>:</p><ul><li><code>0</code>: Modify</li><li><code>1</code>: Add</li><li><code>2</code>: Delete</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=export-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#export-a-container">Export a container</a></h4><p><code>GET /containers/(id or name)/export</code></p><p>Export the contents of container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/4fa6e0f0c678/export HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/octet-stream

{% raw %}
{{ TAR STREAM }}
{% endraw %}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=get-container-stats-based-on-resource-usage><a class="text-black dark:text-white no-underline hover:underline" href="index.html#get-container-stats-based-on-resource-usage">Get container stats based on resource usage</a></h4><p><code>GET /containers/(id or name)/stats</code></p><p>This endpoint returns a live stream of a container's resource usage statistics.</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/redis1/stats HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>  HTTP/1.1 200 OK
  Content-Type: application/json

  {
     &quot;read&quot; : &quot;2015-01-08T22:57:31.547920715Z&quot;,
     &quot;pids_stats&quot;: {
        &quot;current&quot;: 3
     },
     &quot;networks&quot;: {
             &quot;eth0&quot;: {
                 &quot;rx_bytes&quot;: 5338,
                 &quot;rx_dropped&quot;: 0,
                 &quot;rx_errors&quot;: 0,
                 &quot;rx_packets&quot;: 36,
                 &quot;tx_bytes&quot;: 648,
                 &quot;tx_dropped&quot;: 0,
                 &quot;tx_errors&quot;: 0,
                 &quot;tx_packets&quot;: 8
             },
             &quot;eth5&quot;: {
                 &quot;rx_bytes&quot;: 4641,
                 &quot;rx_dropped&quot;: 0,
                 &quot;rx_errors&quot;: 0,
                 &quot;rx_packets&quot;: 26,
                 &quot;tx_bytes&quot;: 690,
                 &quot;tx_dropped&quot;: 0,
                 &quot;tx_errors&quot;: 0,
                 &quot;tx_packets&quot;: 9
             }
     },
     &quot;memory_stats&quot; : {
        &quot;stats&quot; : {
           &quot;total_pgmajfault&quot; : 0,
           &quot;cache&quot; : 0,
           &quot;mapped_file&quot; : 0,
           &quot;total_inactive_file&quot; : 0,
           &quot;pgpgout&quot; : 414,
           &quot;rss&quot; : 6537216,
           &quot;total_mapped_file&quot; : 0,
           &quot;writeback&quot; : 0,
           &quot;unevictable&quot; : 0,
           &quot;pgpgin&quot; : 477,
           &quot;total_unevictable&quot; : 0,
           &quot;pgmajfault&quot; : 0,
           &quot;total_rss&quot; : 6537216,
           &quot;total_rss_huge&quot; : 6291456,
           &quot;total_writeback&quot; : 0,
           &quot;total_inactive_anon&quot; : 0,
           &quot;rss_huge&quot; : 6291456,
           &quot;hierarchical_memory_limit&quot; : 67108864,
           &quot;total_pgfault&quot; : 964,
           &quot;total_active_file&quot; : 0,
           &quot;active_anon&quot; : 6537216,
           &quot;total_active_anon&quot; : 6537216,
           &quot;total_pgpgout&quot; : 414,
           &quot;total_cache&quot; : 0,
           &quot;inactive_anon&quot; : 0,
           &quot;active_file&quot; : 0,
           &quot;pgfault&quot; : 964,
           &quot;inactive_file&quot; : 0,
           &quot;total_pgpgin&quot; : 477
        },
        &quot;max_usage&quot; : 6651904,
        &quot;usage&quot; : 6537216,
        &quot;failcnt&quot; : 0,
        &quot;limit&quot; : 67108864
     },
     &quot;blkio_stats&quot; : {},
     &quot;cpu_stats&quot; : {
        &quot;cpu_usage&quot; : {
           &quot;percpu_usage&quot; : [
              8646879,
              24472255,
              36438778,
              30657443
           ],
           &quot;usage_in_usermode&quot; : 50000000,
           &quot;total_usage&quot; : 100215355,
           &quot;usage_in_kernelmode&quot; : 30000000
        },
        &quot;system_cpu_usage&quot; : 739306590000000,
        &quot;throttling_data&quot; : {&quot;periods&quot;:0,&quot;throttled_periods&quot;:0,&quot;throttled_time&quot;:0}
     },
     &quot;precpu_stats&quot; : {
        &quot;cpu_usage&quot; : {
           &quot;percpu_usage&quot; : [
              8646879,
              24350896,
              36438778,
              30657443
           ],
           &quot;usage_in_usermode&quot; : 50000000,
           &quot;total_usage&quot; : 100093996,
           &quot;usage_in_kernelmode&quot; : 30000000
        },
        &quot;system_cpu_usage&quot; : 9492140000000,
        &quot;throttling_data&quot; : {&quot;periods&quot;:0,&quot;throttled_periods&quot;:0,&quot;throttled_time&quot;:0}
     }
  }
</code></pre><p>The <code>precpu_stats</code> is the cpu statistic of <em>previous</em> read, which is used for calculating the cpu usage percent. It is not the exact copy of the <code>cpu_stats</code> field.</p><p><strong>Query parameters</strong>:</p><ul><li><strong>stream</strong> – 1/True/true or 0/False/false, pull stats once then disconnect. Default <code>true</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=resize-a-container-tty><a class="text-black dark:text-white no-underline hover:underline" href="index.html#resize-a-container-tty">Resize a container TTY</a></h4><p><code>POST /containers/(id or name)/resize</code></p><p>Resize the TTY for container with <code>id</code>. The unit is number of characters. You must restart the container for the resize to take effect.</p><p><strong>Example request</strong>:</p><pre><code>  POST /v1.24/containers/4fa6e0f0c678/resize?h=40&amp;w=80 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>  HTTP/1.1 200 OK
  Content-Length: 0
  Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>h</strong> – height of <code>tty</code> session</li><li><strong>w</strong> – width</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – No such container</li><li><strong>500</strong> – Cannot resize container</li></ul><h4 class=scroll-mt-20 id=start-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#start-a-container">Start a container</a></h4><p><code>POST /containers/(id or name)/start</code></p><p>Start the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/start HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>detachKeys</strong> – Override the key sequence for detaching a
container. Format is a single character <code>[a-Z]</code> or <code>ctrl-&lt;value></code>
where <code>&lt;value></code> is one of: <code>a-z</code>, <code>@</code>, <code>^</code>, <code>[</code>, <code>,</code> or <code>_</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>304</strong> – container already started</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=stop-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#stop-a-container">Stop a container</a></h4><p><code>POST /containers/(id or name)/stop</code></p><p>Stop the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/stop?t=5 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>t</strong> – number of seconds to wait before killing the container</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>304</strong> – container already stopped</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=restart-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#restart-a-container">Restart a container</a></h4><p><code>POST /containers/(id or name)/restart</code></p><p>Restart the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/restart?t=5 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>t</strong> – number of seconds to wait before killing the container</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=kill-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#kill-a-container">Kill a container</a></h4><p><code>POST /containers/(id or name)/kill</code></p><p>Kill the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/kill HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>signal</strong> - Signal to send to the container: integer or string like <code>SIGINT</code>.
When not set, <code>SIGKILL</code> is assumed and the call waits for the container to exit.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=update-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#update-a-container">Update a container</a></h4><p><code>POST /containers/(id or name)/update</code></p><p>Update configuration of one or more containers.</p><p><strong>Example request</strong>:</p><pre><code>   POST /v1.24/containers/e90e34656806/update HTTP/1.1
   Content-Type: application/json
   Content-Length: 12345

   {
     &quot;BlkioWeight&quot;: 300,
     &quot;CpuShares&quot;: 512,
     &quot;CpuPeriod&quot;: 100000,
     &quot;CpuQuota&quot;: 50000,
     &quot;CpusetCpus&quot;: &quot;0,1&quot;,
     &quot;CpusetMems&quot;: &quot;0&quot;,
     &quot;Memory&quot;: 314572800,
     &quot;MemorySwap&quot;: 514288000,
     &quot;MemoryReservation&quot;: 209715200,
     &quot;KernelMemory&quot;: 52428800,
     &quot;RestartPolicy&quot;: {
       &quot;MaximumRetryCount&quot;: 4,
       &quot;Name&quot;: &quot;on-failure&quot;
     }
   }
</code></pre><p><strong>Example response</strong>:</p><pre><code>   HTTP/1.1 200 OK
   Content-Type: application/json

   {
       &quot;Warnings&quot;: []
   }
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=rename-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#rename-a-container">Rename a container</a></h4><p><code>POST /containers/(id or name)/rename</code></p><p>Rename the container <code>id</code> to a <code>new_name</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/rename?name=new_name HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>name</strong> – new name for the container</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>409</strong> - conflict name already assigned</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=pause-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#pause-a-container">Pause a container</a></h4><p><code>POST /containers/(id or name)/pause</code></p><p>Pause the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/pause HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=unpause-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#unpause-a-container">Unpause a container</a></h4><p><code>POST /containers/(id or name)/unpause</code></p><p>Unpause the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/unpause HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=attach-to-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#attach-to-a-container">Attach to a container</a></h4><p><code>POST /containers/(id or name)/attach</code></p><p>Attach to the container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/16253994b7c4/attach?logs=1&amp;stream=0&amp;stdout=1 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 101 UPGRADED
Content-Type: application/vnd.docker.raw-stream
Connection: Upgrade
Upgrade: tcp

{% raw %}
{{ STREAM }}
{% endraw %}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>detachKeys</strong> – Override the key sequence for detaching a
container. Format is a single character <code>[a-Z]</code> or <code>ctrl-&lt;value></code>
where <code>&lt;value></code> is one of: <code>a-z</code>, <code>@</code>, <code>^</code>, <code>[</code>, <code>,</code> or <code>_</code>.</li><li><strong>logs</strong> – 1/True/true or 0/False/false, return logs. Default <code>false</code>.</li><li><strong>stream</strong> – 1/True/true or 0/False/false, return stream.
Default <code>false</code>.</li><li><strong>stdin</strong> – 1/True/true or 0/False/false, if <code>stream=true</code>, attach
to <code>stdin</code>. Default <code>false</code>.</li><li><strong>stdout</strong> – 1/True/true or 0/False/false, if <code>logs=true</code>, return
<code>stdout</code> log, if <code>stream=true</code>, attach to <code>stdout</code>. Default <code>false</code>.</li><li><strong>stderr</strong> – 1/True/true or 0/False/false, if <code>logs=true</code>, return
<code>stderr</code> log, if <code>stream=true</code>, attach to <code>stderr</code>. Default <code>false</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>101</strong> – no error, hints proxy about hijacking</li><li><strong>200</strong> – no error, no upgrade header found</li><li><strong>400</strong> – bad parameter</li><li><strong>404</strong> – no such container</li><li><strong>409</strong> - container is paused</li><li><strong>500</strong> – server error</li></ul><p><strong>Stream details</strong>:</p><p>When using the TTY setting is enabled in
<a class=link href="index.html#create-a-container"><code>POST /containers/create</code>
</a>,
the stream is the raw data from the process PTY and client's <code>stdin</code>.
When the TTY is disabled, then the stream is multiplexed to separate
<code>stdout</code> and <code>stderr</code>.</p><p>The format is a <strong>Header</strong> and a <strong>Payload</strong> (frame).</p><p><strong>HEADER</strong></p><p>The header contains the information which the stream writes (<code>stdout</code> or
<code>stderr</code>). It also contains the size of the associated frame encoded in the
last four bytes (<code>uint32</code>).</p><p>It is encoded on the first eight bytes like this:</p><pre><code>header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
</code></pre><p><code>STREAM_TYPE</code> can be:</p><ul><li>0: <code>stdin</code> (is written on <code>stdout</code>)</li><li>1: <code>stdout</code></li><li>2: <code>stderr</code></li></ul><p><code>SIZE1, SIZE2, SIZE3, SIZE4</code> are the four bytes of
the <code>uint32</code> size encoded as big endian.</p><p><strong>PAYLOAD</strong></p><p>The payload is the raw stream.</p><p><strong>IMPLEMENTATION</strong></p><p>The simplest way to implement the Attach protocol is the following:</p><pre><code>1.  Read eight bytes.
2.  Choose `stdout` or `stderr` depending on the first byte.
3.  Extract the frame size from the last four bytes.
4.  Read the extracted size and output it on the correct output.
5.  Goto 1.
</code></pre><h4 class=scroll-mt-20 id=attach-to-a-container-websocket><a class="text-black dark:text-white no-underline hover:underline" href="index.html#attach-to-a-container-websocket">Attach to a container (websocket)</a></h4><p><code>GET /containers/(id or name)/attach/ws</code></p><p>Attach to the container <code>id</code> via websocket</p><p>Implements websocket protocol handshake according to
<a class=link href=http://tools.ietf.org/html/rfc6455 target=_blank rel=noopener>RFC 6455<span class="icon-svg icon-xs icon-top"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M180-120q-24 0-42-18t-18-42v-6e2q0-24 18-42t42-18h249q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T429-780H180v6e2h6e2v-249q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T840-429v249q0 24-18 42t-42 18H180zm6e2-617L403-360q-9 9-21 8.5t-21-9.5-9-21 9-21l377-377H549q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T549-840h291v291q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625-12.825.0-21.325-8.625T780-549v-188z"/></svg></span></a></p><p><strong>Example request</strong></p><pre><code>GET /v1.24/containers/e90e34656806/attach/ws?logs=0&amp;stream=1&amp;stdin=1&amp;stdout=1&amp;stderr=1 HTTP/1.1
</code></pre><p><strong>Example response</strong></p><pre><code>{% raw %}
{{ STREAM }}
{% endraw %}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>detachKeys</strong> – Override the key sequence for detaching a
container. Format is a single character <code>[a-Z]</code> or <code>ctrl-&lt;value></code>
where <code>&lt;value></code> is one of: <code>a-z</code>, <code>@</code>, <code>^</code>, <code>[</code>, <code>,</code> or <code>_</code>.</li><li><strong>logs</strong> – 1/True/true or 0/False/false, return logs. Default <code>false</code>.</li><li><strong>stream</strong> – 1/True/true or 0/False/false, return stream.
Default <code>false</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=wait-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#wait-a-container">Wait a container</a></h4><p><code>POST /containers/(id or name)/wait</code></p><p>Block until container <code>id</code> stops, then returns the exit code</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/16253994b7c4/wait HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{&quot;StatusCode&quot;: 0}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=remove-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-a-container">Remove a container</a></h4><p><code>DELETE /containers/(id or name)</code></p><p>Remove the container <code>id</code> from the filesystem</p><p><strong>Example request</strong>:</p><pre><code>DELETE /v1.24/containers/16253994b7c4?v=1 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>v</strong> – 1/True/true or 0/False/false, Remove the volumes
associated to the container. Default <code>false</code>.</li><li><strong>force</strong> - 1/True/true or 0/False/false, Kill then remove the container.
Default <code>false</code>.</li><li><strong>link</strong> - 1/True/true or 0/False/false, Remove the specified
link associated to the container. Default <code>false</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>404</strong> – no such container</li><li><strong>409</strong> – conflict</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=retrieving-information-about-files-and-folders-in-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#retrieving-information-about-files-and-folders-in-a-container">Retrieving information about files and folders in a container</a></h4><p><code>HEAD /containers/(id or name)/archive</code></p><p>See the description of the <code>X-Docker-Container-Path-Stat</code> header in the
following section.</p><h4 class=scroll-mt-20 id=get-an-archive-of-a-filesystem-resource-in-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#get-an-archive-of-a-filesystem-resource-in-a-container">Get an archive of a filesystem resource in a container</a></h4><p><code>GET /containers/(id or name)/archive</code></p><p>Get a tar archive of a resource in the filesystem of container <code>id</code>.</p><p><strong>Query parameters</strong>:</p><ul><li><p><strong>path</strong> - resource in the container's filesystem to archive. Required.</p><p>If not an absolute path, it is relative to the container's root directory.
The resource specified by <strong>path</strong> must exist. To assert that the resource
is expected to be a directory, <strong>path</strong> should end in <code>/</code> or <code>/.</code>
(assuming a path separator of <code>/</code>). If <strong>path</strong> ends in <code>/.</code> then this
indicates that only the contents of the <strong>path</strong> directory should be
copied. A symlink is always resolved to its target.</p><blockquote><p><strong>Note</strong>: It is not possible to copy certain system files such as resources
under <code>/proc</code>, <code>/sys</code>, <code>/dev</code>, and mounts created by the user in the
container.</p></blockquote></li></ul><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/containers/8cce319429b2/archive?path=/root HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/x-tar
X-Docker-Container-Path-Stat: eyJuYW1lIjoicm9vdCIsInNpemUiOjQwOTYsIm1vZGUiOjIxNDc0ODQwOTYsIm10aW1lIjoiMjAxNC0wMi0yN1QyMDo1MToyM1oiLCJsaW5rVGFyZ2V0IjoiIn0=

{% raw %}
{{ TAR STREAM }}
{% endraw %}
</code></pre><p>On success, a response header <code>X-Docker-Container-Path-Stat</code> will be set to a
base64-encoded JSON object containing some filesystem header information about
the archived resource. The above example value would decode to the following
JSON object (whitespace added for readability):</p><div class="group relative"><button x-data="{ code: 'ewogICAgIm5hbWUiOiAicm9vdCIsCiAgICAic2l6ZSI6IDQwOTYsCiAgICAibW9kZSI6IDIxNDc0ODQwOTYsCiAgICAibXRpbWUiOiAiMjAxNC0wMi0yN1QyMDo1MToyM1oiLAogICAgImxpbmtUYXJnZXQiOiAiIgp9', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><div class=highlight><pre tabindex=0 class=chroma><code class=language-json data-lang=json><span class=line><span class=cl><span class=p>{</span>
</span></span><span class=line><span class=cl>    <span class=nt>&#34;name&#34;</span><span class=p>:</span> <span class=s2>&#34;root&#34;</span><span class=p>,</span>
</span></span><span class=line><span class=cl>    <span class=nt>&#34;size&#34;</span><span class=p>:</span> <span class=mi>4096</span><span class=p>,</span>
</span></span><span class=line><span class=cl>    <span class=nt>&#34;mode&#34;</span><span class=p>:</span> <span class=mi>2147484096</span><span class=p>,</span>
</span></span><span class=line><span class=cl>    <span class=nt>&#34;mtime&#34;</span><span class=p>:</span> <span class=s2>&#34;2014-02-27T20:51:23Z&#34;</span><span class=p>,</span>
</span></span><span class=line><span class=cl>    <span class=nt>&#34;linkTarget&#34;</span><span class=p>:</span> <span class=s2>&#34;&#34;</span>
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></div></div><p>A <code>HEAD</code> request can also be made to this endpoint if only this information is
desired.</p><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - success, returns archive of copied resource</li><li><strong>400</strong> - client error, bad parameter, details in JSON response body, one of:<ul><li>must specify path parameter (<strong>path</strong> cannot be empty)</li><li>not a directory (<strong>path</strong> was asserted to be a directory but exists as a
file)</li></ul></li><li><strong>404</strong> - client error, resource not found, one of:
– no such container (container <code>id</code> does not exist)<ul><li>no such file or directory (<strong>path</strong> does not exist)</li></ul></li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=extract-an-archive-of-files-or-folders-to-a-directory-in-a-container><a class="text-black dark:text-white no-underline hover:underline" href="index.html#extract-an-archive-of-files-or-folders-to-a-directory-in-a-container">Extract an archive of files or folders to a directory in a container</a></h4><p><code>PUT /containers/(id or name)/archive</code></p><p>Upload a tar archive to be extracted to a path in the filesystem of container
<code>id</code>.</p><p><strong>Query parameters</strong>:</p><ul><li><p><strong>path</strong> - path to a directory in the container
to extract the archive's contents into. Required.</p><p>If not an absolute path, it is relative to the container's root directory.
The <strong>path</strong> resource must exist.</p></li><li><p><strong>noOverwriteDirNonDir</strong> - If "1", "true", or "True" then it will be an error
if unpacking the given content would cause an existing directory to be
replaced with a non-directory and vice versa.</p></li></ul><p><strong>Example request</strong>:</p><pre><code>PUT /v1.24/containers/8cce319429b2/archive?path=/vol1 HTTP/1.1
Content-Type: application/x-tar

{% raw %}
{{ TAR STREAM }}
{% endraw %}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – the content was extracted successfully</li><li><strong>400</strong> - client error, bad parameter, details in JSON response body, one of:<ul><li>must specify path parameter (<strong>path</strong> cannot be empty)</li><li>not a directory (<strong>path</strong> should be a directory but exists as a file)</li><li>unable to overwrite existing directory with non-directory
(if <strong>noOverwriteDirNonDir</strong>)</li><li>unable to overwrite existing non-directory with directory
(if <strong>noOverwriteDirNonDir</strong>)</li></ul></li><li><strong>403</strong> - client error, permission denied, the volume
or container rootfs is marked as read-only.</li><li><strong>404</strong> - client error, resource not found, one of:
– no such container (container <code>id</code> does not exist)<ul><li>no such file or directory (<strong>path</strong> resource does not exist)</li></ul></li><li><strong>500</strong> – server error</li></ul><h3 class=scroll-mt-20 id=32-images><a class="text-black dark:text-white no-underline hover:underline" href="index.html#32-images">3.2 Images</a></h3><h4 class=scroll-mt-20 id=list-images><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-images">List Images</a></h4><p><code>GET /images/json</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/images/json?all=0 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
  {
     &quot;RepoTags&quot;: [
       &quot;ubuntu:12.04&quot;,
       &quot;ubuntu:precise&quot;,
       &quot;ubuntu:latest&quot;
     ],
     &quot;Id&quot;: &quot;8dbd9e392a964056420e5d58ca5cc376ef18e2de93b5cc90e868a1bbc8318c1c&quot;,
     &quot;Created&quot;: 1365714795,
     &quot;Size&quot;: 131506275,
     &quot;VirtualSize&quot;: 131506275,
     &quot;Labels&quot;: {}
  },
  {
     &quot;RepoTags&quot;: [
       &quot;ubuntu:12.10&quot;,
       &quot;ubuntu:quantal&quot;
     ],
     &quot;ParentId&quot;: &quot;27cf784147099545&quot;,
     &quot;Id&quot;: &quot;b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc&quot;,
     &quot;Created&quot;: 1364102658,
     &quot;Size&quot;: 24653,
     &quot;VirtualSize&quot;: 180116135,
     &quot;Labels&quot;: {
        &quot;com.example.version&quot;: &quot;v1&quot;
     }
  }
]
</code></pre><p><strong>Example request, with digest information</strong>:</p><pre><code>GET /v1.24/images/json?digests=1 HTTP/1.1
</code></pre><p><strong>Example response, with digest information</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    &quot;Created&quot;: 1420064636,
    &quot;Id&quot;: &quot;4986bf8c15363d1c5d15512d5266f8777bfba4974ac56e3270e7760f6f0a8125&quot;,
    &quot;ParentId&quot;: &quot;ea13149945cb6b1e746bf28032f02e9b5a793523481a0a18645fc77ad53c4ea2&quot;,
    &quot;RepoDigests&quot;: [
      &quot;localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf&quot;
    ],
    &quot;RepoTags&quot;: [
      &quot;localhost:5000/test/busybox:latest&quot;,
      &quot;playdate:latest&quot;
    ],
    &quot;Size&quot;: 0,
    &quot;VirtualSize&quot;: 2429728,
    &quot;Labels&quot;: {}
  }
]
</code></pre><p>The response shows a single image <code>Id</code> associated with two repositories
(<code>RepoTags</code>): <code>localhost:5000/test/busybox</code>: and <code>playdate</code>. A caller can use
either of the <code>RepoTags</code> values <code>localhost:5000/test/busybox:latest</code> or
<code>playdate:latest</code> to reference the image.</p><p>You can also use <code>RepoDigests</code> values to reference an image. In this response,
the array has only one reference and that is to the
<code>localhost:5000/test/busybox</code> repository; the <code>playdate</code> repository has no
digest. You can reference this digest using the value:
<code>localhost:5000/test/busybox@sha256:cbbf2f9a99b47fc460d...</code></p><p>See the <code>docker run</code> and <code>docker build</code> commands for examples of digest and tag
references on the command line.</p><p><strong>Query parameters</strong>:</p><ul><li><strong>all</strong> – 1/True/true or 0/False/false, default false</li><li><strong>filters</strong> – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:</li><li><code>dangling=true</code></li><li><code>label=key</code> or <code>label="key=value"</code> of an image label</li><li><code>before</code>=(<code>&lt;image-name>[:&lt;tag>]</code>, <code>&lt;image id></code> or <code>&lt;image@digest></code>)</li><li><code>since</code>=(<code>&lt;image-name>[:&lt;tag>]</code>, <code>&lt;image id></code> or <code>&lt;image@digest></code>)</li><li><strong>filter</strong> - only return images with the specified name</li></ul><h4 class=scroll-mt-20 id=build-image-from-a-dockerfile><a class="text-black dark:text-white no-underline hover:underline" href="index.html#build-image-from-a-dockerfile">Build image from a Dockerfile</a></h4><p><code>POST /build</code></p><p>Build an image from a Dockerfile</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/build HTTP/1.1
Content-Type: application/x-tar

{% raw %}
{{ TAR STREAM }}
{% endraw %}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{&quot;stream&quot;: &quot;Step 1/5...&quot;}
{&quot;stream&quot;: &quot;...&quot;}
{&quot;error&quot;: &quot;Error...&quot;, &quot;errorDetail&quot;: {&quot;code&quot;: 123, &quot;message&quot;: &quot;Error...&quot;}}
</code></pre><p>The input stream must be a <code>tar</code> archive compressed with one of the
following algorithms: <code>identity</code> (no compression), <code>gzip</code>, <code>bzip2</code>, <code>xz</code>.</p><p>The archive must include a build instructions file, typically called
<code>Dockerfile</code> at the archive's root. The <code>dockerfile</code> parameter may be
used to specify a different build instructions file. To do this, its value must be
the path to the alternate build instructions file to use.</p><p>The archive may include any number of other files,
which are accessible in the build context (See the
<a class=link href="../../reference/builder/index.html#add" target=_blank rel=noopener><em>ADD build
command</em><span class="icon-svg icon-xs icon-top"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M180-120q-24 0-42-18t-18-42v-6e2q0-24 18-42t42-18h249q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T429-780H180v6e2h6e2v-249q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T840-429v249q0 24-18 42t-42 18H180zm6e2-617L403-360q-9 9-21 8.5t-21-9.5-9-21 9-21l377-377H549q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T549-840h291v291q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625-12.825.0-21.325-8.625T780-549v-188z"/></svg></span></a>).</p><p>The Docker daemon performs a preliminary validation of the <code>Dockerfile</code> before
starting the build, and returns an error if the syntax is incorrect. After that,
each instruction is run one-by-one until the ID of the new image is output.</p><p>The build is canceled if the client drops the connection by quitting
or being killed.</p><p><strong>Query parameters</strong>:</p><ul><li><strong>dockerfile</strong> - Path within the build context to the <code>Dockerfile</code>. This is
ignored if <code>remote</code> is specified and points to an external <code>Dockerfile</code>.</li><li><strong>t</strong> – A name and optional tag to apply to the image in the <code>name:tag</code> format.
If you omit the <code>tag</code> the default <code>latest</code> value is assumed.
You can provide one or more <code>t</code> parameters.</li><li><strong>remote</strong> – A Git repository URI or HTTP/HTTPS context URI. If the
URI points to a single text file, the file's contents are placed into
a file called <code>Dockerfile</code> and the image is built from that file. If
the URI points to a tarball, the file is downloaded by the daemon and
the contents therein used as the context for the build. If the URI
points to a tarball and the <code>dockerfile</code> parameter is also specified,
there must be a file with the corresponding path inside the tarball.</li><li><strong>q</strong> – Suppress verbose build output.</li><li><strong>nocache</strong> – Do not use the cache when building the image.</li><li><strong>pull</strong> - Attempt to pull the image even if an older image exists locally.</li><li><strong>rm</strong> - Remove intermediate containers after a successful build (default behavior).</li><li><strong>forcerm</strong> - Always remove intermediate containers (includes <code>rm</code>).</li><li><strong>memory</strong> - Set memory limit for build.</li><li><strong>memswap</strong> - Total memory (memory + swap), <code>-1</code> to enable unlimited swap.</li><li><strong>cpushares</strong> - CPU shares (relative weight).</li><li><strong>cpusetcpus</strong> - CPUs in which to allow execution (e.g., <code>0-3</code>, <code>0,1</code>).</li><li><strong>cpuperiod</strong> - The length of a CPU period in microseconds.</li><li><strong>cpuquota</strong> - Microseconds of CPU time that the container can get in a CPU period.</li><li><strong>buildargs</strong> – JSON map of string pairs for build-time variables. Users pass
these values at build-time. Docker uses the <code>buildargs</code> as the environment
context for command(s) run via the Dockerfile's <code>RUN</code> instruction or for
variable expansion in other Dockerfile instructions. This is not meant for
passing secret values.
<a class=link href="../../reference/builder/index.html#arg" target=_blank rel=noopener>Read more about the buildargs instruction<span class="icon-svg icon-xs icon-top"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M180-120q-24 0-42-18t-18-42v-6e2q0-24 18-42t42-18h249q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T429-780H180v6e2h6e2v-249q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T840-429v249q0 24-18 42t-42 18H180zm6e2-617L403-360q-9 9-21 8.5t-21-9.5-9-21 9-21l377-377H549q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T549-840h291v291q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625-12.825.0-21.325-8.625T780-549v-188z"/></svg></span></a></li><li><strong>shmsize</strong> - Size of <code>/dev/shm</code> in bytes. The size must be greater than 0. If omitted the system uses 64MB.</li><li><strong>labels</strong> – JSON map of string pairs for labels to set on the image.</li></ul><p><strong>Request Headers</strong>:</p><ul><li><p><strong>Content-type</strong> – Set to <code>"application/x-tar"</code>.</p></li><li><p><strong>X-Registry-Config</strong> – A base64-url-safe-encoded Registry Auth Config JSON
object with the following structure:</p><pre><code>    {
        &quot;docker.example.com&quot;: {
            &quot;username&quot;: &quot;janedoe&quot;,
            &quot;password&quot;: &quot;hunter2&quot;
        },
        &quot;https://index.docker.io/v1/&quot;: {
            &quot;username&quot;: &quot;mobydock&quot;,
            &quot;password&quot;: &quot;conta1n3rize14&quot;
        }
    }
</code></pre><p>This object maps the hostname of a registry to an object containing the
"username" and "password" for that registry. Multiple registries may
be specified as the build may be based on an image requiring
authentication to pull from any arbitrary registry. Only the registry
domain name (and port if not the default "443") are required. However
(for legacy reasons) the "official" Docker, Inc. hosted registry must
be specified with both a "https://" prefix and a "/v1/" suffix even
though Docker will prefer to use the v2 registry API.</p></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=create-an-image><a class="text-black dark:text-white no-underline hover:underline" href="index.html#create-an-image">Create an image</a></h4><p><code>POST /images/create</code></p><p>Create an image either by pulling it from the registry or by importing it</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/images/create?fromImage=busybox&amp;tag=latest HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{&quot;status&quot;: &quot;Pulling...&quot;}
{&quot;status&quot;: &quot;Pulling&quot;, &quot;progress&quot;: &quot;1 B/ 100 B&quot;, &quot;progressDetail&quot;: {&quot;current&quot;: 1, &quot;total&quot;: 100}}
{&quot;error&quot;: &quot;Invalid...&quot;}
...
</code></pre><p>When using this endpoint to pull an image from the registry, the
<code>X-Registry-Auth</code> header can be used to include
a base64-encoded AuthConfig object.</p><p><strong>Query parameters</strong>:</p><ul><li><strong>fromImage</strong> – Name of the image to pull. The name may include a tag or
digest. This parameter may only be used when pulling an image.
The pull is cancelled if the HTTP connection is closed.</li><li><strong>fromSrc</strong> – Source to import. The value may be a URL from which the image
can be retrieved or <code>-</code> to read the image from the request body.
This parameter may only be used when importing an image.</li><li><strong>repo</strong> – Repository name given to an image when it is imported.
The repo may include a tag. This parameter may only be used when importing
an image.</li><li><strong>tag</strong> – Tag or digest. If empty when pulling an image, this causes all tags
for the given image to be pulled.</li></ul><p><strong>Request Headers</strong>:</p><ul><li><p><strong>X-Registry-Auth</strong> – base64-encoded AuthConfig object, containing either login information, or a token</p><ul><li><p>Credential based login:</p><div class="group relative"><button x-data="{ code: '', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code></code></pre></div></div></li></ul><p>{
"username": "jdoe",
"password": "secret",
"email": "jdoe@acme.com"
}
```</p><ul><li><p>Token based login:</p><div class="group relative"><button x-data="{ code: '', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code></code></pre></div></div></li></ul><p>{
"identitytoken": "9cbaf023786cd7..."
}
```</p></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> - repository does not exist or no read access</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=inspect-an-image><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-an-image">Inspect an image</a></h4><p><code>GET /images/(name)/json</code></p><p>Return low-level information on the image <code>name</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/images/example/json HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
   &quot;Id&quot; : &quot;sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c&quot;,
   &quot;Container&quot; : &quot;cb91e48a60d01f1e27028b4fc6819f4f290b3cf12496c8176ec714d0d390984a&quot;,
   &quot;Comment&quot; : &quot;&quot;,
   &quot;Os&quot; : &quot;linux&quot;,
   &quot;Architecture&quot; : &quot;amd64&quot;,
   &quot;Parent&quot; : &quot;sha256:91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c&quot;,
   &quot;ContainerConfig&quot; : {
      &quot;Tty&quot; : false,
      &quot;Hostname&quot; : &quot;e611e15f9c9d&quot;,
      &quot;Volumes&quot; : null,
      &quot;Domainname&quot; : &quot;&quot;,
      &quot;AttachStdout&quot; : false,
      &quot;PublishService&quot; : &quot;&quot;,
      &quot;AttachStdin&quot; : false,
      &quot;OpenStdin&quot; : false,
      &quot;StdinOnce&quot; : false,
      &quot;NetworkDisabled&quot; : false,
      &quot;OnBuild&quot; : [],
      &quot;Image&quot; : &quot;91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c&quot;,
      &quot;User&quot; : &quot;&quot;,
      &quot;WorkingDir&quot; : &quot;&quot;,
      &quot;Entrypoint&quot; : null,
      &quot;MacAddress&quot; : &quot;&quot;,
      &quot;AttachStderr&quot; : false,
      &quot;Labels&quot; : {
         &quot;com.example.license&quot; : &quot;GPL&quot;,
         &quot;com.example.version&quot; : &quot;1.0&quot;,
         &quot;com.example.vendor&quot; : &quot;Acme&quot;
      },
      &quot;Env&quot; : [
         &quot;PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin&quot;
      ],
      &quot;ExposedPorts&quot; : null,
      &quot;Cmd&quot; : [
         &quot;/bin/sh&quot;,
         &quot;-c&quot;,
         &quot;#(nop) LABEL com.example.vendor=Acme com.example.license=GPL com.example.version=1.0&quot;
      ]
   },
   &quot;DockerVersion&quot; : &quot;1.9.0-dev&quot;,
   &quot;VirtualSize&quot; : 188359297,
   &quot;Size&quot; : 0,
   &quot;Author&quot; : &quot;&quot;,
   &quot;Created&quot; : &quot;2015-09-10T08:30:53.26995814Z&quot;,
   &quot;GraphDriver&quot; : {
      &quot;Name&quot; : &quot;aufs&quot;,
      &quot;Data&quot; : null
   },
   &quot;RepoDigests&quot; : [
      &quot;localhost:5000/test/busybox/example@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf&quot;
   ],
   &quot;RepoTags&quot; : [
      &quot;example:1.0&quot;,
      &quot;example:latest&quot;,
      &quot;example:stable&quot;
   ],
   &quot;Config&quot; : {
      &quot;Image&quot; : &quot;91e54dfb11794fad694460162bf0cb0a4fa710cfa3f60979c177d920813e267c&quot;,
      &quot;NetworkDisabled&quot; : false,
      &quot;OnBuild&quot; : [],
      &quot;StdinOnce&quot; : false,
      &quot;PublishService&quot; : &quot;&quot;,
      &quot;AttachStdin&quot; : false,
      &quot;OpenStdin&quot; : false,
      &quot;Domainname&quot; : &quot;&quot;,
      &quot;AttachStdout&quot; : false,
      &quot;Tty&quot; : false,
      &quot;Hostname&quot; : &quot;e611e15f9c9d&quot;,
      &quot;Volumes&quot; : null,
      &quot;Cmd&quot; : [
         &quot;/bin/bash&quot;
      ],
      &quot;ExposedPorts&quot; : null,
      &quot;Env&quot; : [
         &quot;PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin&quot;
      ],
      &quot;Labels&quot; : {
         &quot;com.example.vendor&quot; : &quot;Acme&quot;,
         &quot;com.example.version&quot; : &quot;1.0&quot;,
         &quot;com.example.license&quot; : &quot;GPL&quot;
      },
      &quot;Entrypoint&quot; : null,
      &quot;MacAddress&quot; : &quot;&quot;,
      &quot;AttachStderr&quot; : false,
      &quot;WorkingDir&quot; : &quot;&quot;,
      &quot;User&quot; : &quot;&quot;
   },
   &quot;RootFS&quot;: {
       &quot;Type&quot;: &quot;layers&quot;,
       &quot;Layers&quot;: [
           &quot;sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6&quot;,
           &quot;sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef&quot;
       ]
   }
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such image</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=get-the-history-of-an-image><a class="text-black dark:text-white no-underline hover:underline" href="index.html#get-the-history-of-an-image">Get the history of an image</a></h4><p><code>GET /images/(name)/history</code></p><p>Return the history of the image <code>name</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/images/ubuntu/history HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        &quot;Id&quot;: &quot;3db9c44f45209632d6050b35958829c3a2aa256d81b9a7be45b362ff85c54710&quot;,
        &quot;Created&quot;: 1398108230,
        &quot;CreatedBy&quot;: &quot;/bin/sh -c #(nop) ADD file:eb15dbd63394e063b805a3c32ca7bf0266ef64676d5a6fab4801f2e81e2a5148 in /&quot;,
        &quot;Tags&quot;: [
            &quot;ubuntu:lucid&quot;,
            &quot;ubuntu:10.04&quot;
        ],
        &quot;Size&quot;: 182964289,
        &quot;Comment&quot;: &quot;&quot;
    },
    {
        &quot;Id&quot;: &quot;6cfa4d1f33fb861d4d114f43b25abd0ac737509268065cdfd69d544a59c85ab8&quot;,
        &quot;Created&quot;: 1398108222,
        &quot;CreatedBy&quot;: &quot;/bin/sh -c #(nop) MAINTAINER Tianon Gravi &lt;admwiggin@gmail.com&gt; - mkimage-debootstrap.sh -i iproute,iputils-ping,ubuntu-minimal -t lucid.tar.xz lucid http://archive.ubuntu.com/ubuntu/&quot;,
        &quot;Tags&quot;: null,
        &quot;Size&quot;: 0,
        &quot;Comment&quot;: &quot;&quot;
    },
    {
        &quot;Id&quot;: &quot;511136ea3c5a64f264b78b5433614aec563103b4d4702f3ba7d4d2698e22c158&quot;,
        &quot;Created&quot;: 1371157430,
        &quot;CreatedBy&quot;: &quot;&quot;,
        &quot;Tags&quot;: [
            &quot;scratch12:latest&quot;,
            &quot;scratch:latest&quot;
        ],
        &quot;Size&quot;: 0,
        &quot;Comment&quot;: &quot;Imported from -&quot;
    }
]
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such image</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=push-an-image-on-the-registry><a class="text-black dark:text-white no-underline hover:underline" href="index.html#push-an-image-on-the-registry">Push an image on the registry</a></h4><p><code>POST /images/(name)/push</code></p><p>Push the image <code>name</code> on the registry</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/images/test/push HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{&quot;status&quot;: &quot;Pushing...&quot;}
{&quot;status&quot;: &quot;Pushing&quot;, &quot;progress&quot;: &quot;1/? (n/a)&quot;, &quot;progressDetail&quot;: {&quot;current&quot;: 1}}}
{&quot;error&quot;: &quot;Invalid...&quot;}
...
</code></pre><p>If you wish to push an image on to a private registry, that image must already have a tag
into a repository which references that registry <code>hostname</code> and <code>port</code>. This repository name should
then be used in the URL. This duplicates the command line's flow.</p><p>The push is cancelled if the HTTP connection is closed.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/images/registry.acme.com:5000/test/push HTTP/1.1
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>tag</strong> – The tag to associate with the image on the registry. This is optional.</li></ul><p><strong>Request Headers</strong>:</p><ul><li><p><strong>X-Registry-Auth</strong> – base64-encoded AuthConfig object, containing either login information, or a token</p><ul><li><p>Credential based login:</p><div class="group relative"><button x-data="{ code: '', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code></code></pre></div></div></li></ul><p>{
"username": "jdoe",
"password": "secret",
"email": "jdoe@acme.com",
}
```</p><ul><li><p>Identity token based login:</p><div class="group relative"><button x-data="{ code: '', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code></code></pre></div></div></li></ul><p>{
"identitytoken": "9cbaf023786cd7..."
}
```</p></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such image</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=tag-an-image-into-a-repository><a class="text-black dark:text-white no-underline hover:underline" href="index.html#tag-an-image-into-a-repository">Tag an image into a repository</a></h4><p><code>POST /images/(name)/tag</code></p><p>Tag the image <code>name</code> into a repository</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/images/test/tag?repo=myrepo&amp;tag=v42 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 201 Created
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>repo</strong> – The repository to tag in</li><li><strong>tag</strong> - The new tag name</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>404</strong> – no such image</li><li><strong>409</strong> – conflict</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=remove-an-image><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-an-image">Remove an image</a></h4><p><code>DELETE /images/(name)</code></p><p>Remove the image <code>name</code> from the filesystem</p><p><strong>Example request</strong>:</p><pre><code>DELETE /v1.24/images/test HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-type: application/json

[
 {&quot;Untagged&quot;: &quot;3e2f21a89f&quot;},
 {&quot;Deleted&quot;: &quot;3e2f21a89f&quot;},
 {&quot;Deleted&quot;: &quot;53b4f83ac9&quot;}
]
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>force</strong> – 1/True/true or 0/False/false, default false</li><li><strong>noprune</strong> – 1/True/true or 0/False/false, default false</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such image</li><li><strong>409</strong> – conflict</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=search-images><a class="text-black dark:text-white no-underline hover:underline" href="index.html#search-images">Search images</a></h4><p><code>GET /images/search</code></p><p>Search for an image on
<a class=link href=https://hub.docker.com target=_blank rel=noopener>Docker Hub<span class="icon-svg icon-xs icon-top"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M180-120q-24 0-42-18t-18-42v-6e2q0-24 18-42t42-18h249q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T429-780H180v6e2h6e2v-249q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T840-429v249q0 24-18 42t-42 18H180zm6e2-617L403-360q-9 9-21 8.5t-21-9.5-9-21 9-21l377-377H549q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T549-840h291v291q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625-12.825.0-21.325-8.625T780-549v-188z"/></svg></span></a>.</p><blockquote><p><strong>Note</strong>:
The response keys have changed from API v1.6 to reflect the JSON
sent by the registry server to the docker daemon's request.</p></blockquote><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/images/search?term=sshd HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
        {
            &quot;description&quot;: &quot;&quot;,
            &quot;is_official&quot;: false,
            &quot;is_automated&quot;: false,
            &quot;name&quot;: &quot;wma55/u1210sshd&quot;,
            &quot;star_count&quot;: 0
        },
        {
            &quot;description&quot;: &quot;&quot;,
            &quot;is_official&quot;: false,
            &quot;is_automated&quot;: false,
            &quot;name&quot;: &quot;jdswinbank/sshd&quot;,
            &quot;star_count&quot;: 0
        },
        {
            &quot;description&quot;: &quot;&quot;,
            &quot;is_official&quot;: false,
            &quot;is_automated&quot;: false,
            &quot;name&quot;: &quot;vgauthier/sshd&quot;,
            &quot;star_count&quot;: 0
        }
...
]
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>term</strong> – term to search</li><li><strong>limit</strong> – maximum returned search results</li><li><strong>filters</strong> – a JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:</li><li><code>stars=&lt;number></code></li><li><code>is-automated=(true|false)</code></li><li><code>is-official=(true|false)</code></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h3 class=scroll-mt-20 id=33-misc><a class="text-black dark:text-white no-underline hover:underline" href="index.html#33-misc">3.3 Misc</a></h3><h4 class=scroll-mt-20 id=check-auth-configuration><a class="text-black dark:text-white no-underline hover:underline" href="index.html#check-auth-configuration">Check auth configuration</a></h4><p><code>POST /auth</code></p><p>Validate credentials for a registry and get identity token,
if available, for accessing the registry without password.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/auth HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
     &quot;username&quot;: &quot;hannibal&quot;,
     &quot;password&quot;: &quot;xxxx&quot;,
     &quot;serveraddress&quot;: &quot;https://index.docker.io/v1/&quot;
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK

{
     &quot;Status&quot;: &quot;Login Succeeded&quot;,
     &quot;IdentityToken&quot;: &quot;9cbaf023786cd7...&quot;
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>204</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=display-system-wide-information><a class="text-black dark:text-white no-underline hover:underline" href="index.html#display-system-wide-information">Display system-wide information</a></h4><p><code>GET /info</code></p><p>Display system-wide information</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/info HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
    &quot;Architecture&quot;: &quot;x86_64&quot;,
    &quot;ClusterStore&quot;: &quot;etcd://localhost:2379&quot;,
    &quot;CgroupDriver&quot;: &quot;cgroupfs&quot;,
    &quot;Containers&quot;: 11,
    &quot;ContainersRunning&quot;: 7,
    &quot;ContainersStopped&quot;: 3,
    &quot;ContainersPaused&quot;: 1,
    &quot;CpuCfsPeriod&quot;: true,
    &quot;CpuCfsQuota&quot;: true,
    &quot;Debug&quot;: false,
    &quot;DockerRootDir&quot;: &quot;/var/lib/docker&quot;,
    &quot;Driver&quot;: &quot;btrfs&quot;,
    &quot;DriverStatus&quot;: [[&quot;&quot;]],
    &quot;ExperimentalBuild&quot;: false,
    &quot;HttpProxy&quot;: &quot;http://test:test@localhost:8080&quot;,
    &quot;HttpsProxy&quot;: &quot;https://test:test@localhost:8080&quot;,
    &quot;ID&quot;: &quot;7TRN:IPZB:QYBB:VPBQ:UMPP:KARE:6ZNR:XE6T:7EWV:PKF4:ZOJD:TPYS&quot;,
    &quot;IPv4Forwarding&quot;: true,
    &quot;Images&quot;: 16,
    &quot;IndexServerAddress&quot;: &quot;https://index.docker.io/v1/&quot;,
    &quot;InitPath&quot;: &quot;/usr/bin/docker&quot;,
    &quot;InitSha1&quot;: &quot;&quot;,
    &quot;KernelMemory&quot;: true,
    &quot;KernelVersion&quot;: &quot;3.12.0-1-amd64&quot;,
    &quot;Labels&quot;: [
        &quot;storage=ssd&quot;
    ],
    &quot;MemTotal&quot;: 2099236864,
    &quot;MemoryLimit&quot;: true,
    &quot;NCPU&quot;: 1,
    &quot;NEventsListener&quot;: 0,
    &quot;NFd&quot;: 11,
    &quot;NGoroutines&quot;: 21,
    &quot;Name&quot;: &quot;prod-server-42&quot;,
    &quot;NoProxy&quot;: &quot;9.81.1.160&quot;,
    &quot;OomKillDisable&quot;: true,
    &quot;OSType&quot;: &quot;linux&quot;,
    &quot;OperatingSystem&quot;: &quot;Boot2Docker&quot;,
    &quot;Plugins&quot;: {
        &quot;Volume&quot;: [
            &quot;local&quot;
        ],
        &quot;Network&quot;: [
            &quot;null&quot;,
            &quot;host&quot;,
            &quot;bridge&quot;
        ]
    },
    &quot;RegistryConfig&quot;: {
        &quot;IndexConfigs&quot;: {
            &quot;docker.io&quot;: {
                &quot;Mirrors&quot;: null,
                &quot;Name&quot;: &quot;docker.io&quot;,
                &quot;Official&quot;: true,
                &quot;Secure&quot;: true
            }
        },
        &quot;InsecureRegistryCIDRs&quot;: [
            &quot;127.0.0.0/8&quot;
        ]
    },
    &quot;SecurityOptions&quot;: [
        &quot;apparmor&quot;,
        &quot;seccomp&quot;,
        &quot;selinux&quot;
    ],
    &quot;ServerVersion&quot;: &quot;1.9.0&quot;,
    &quot;SwapLimit&quot;: false,
    &quot;SystemStatus&quot;: [[&quot;State&quot;, &quot;Healthy&quot;]],
    &quot;SystemTime&quot;: &quot;2015-03-10T11:11:23.730591467-07:00&quot;
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=show-the-docker-version-information><a class="text-black dark:text-white no-underline hover:underline" href="index.html#show-the-docker-version-information">Show the docker version information</a></h4><p><code>GET /version</code></p><p>Show the docker version information</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/version HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
     &quot;Version&quot;: &quot;1.12.0&quot;,
     &quot;Os&quot;: &quot;linux&quot;,
     &quot;KernelVersion&quot;: &quot;3.19.0-23-generic&quot;,
     &quot;GoVersion&quot;: &quot;go1.6.3&quot;,
     &quot;GitCommit&quot;: &quot;deadbee&quot;,
     &quot;Arch&quot;: &quot;amd64&quot;,
     &quot;ApiVersion&quot;: &quot;1.24&quot;,
     &quot;BuildTime&quot;: &quot;2016-06-14T07:09:13.444803460+00:00&quot;,
     &quot;Experimental&quot;: true
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=ping-the-docker-server><a class="text-black dark:text-white no-underline hover:underline" href="index.html#ping-the-docker-server">Ping the docker server</a></h4><p><code>GET /_ping</code></p><p>Ping the docker server</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/_ping HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: text/plain

OK
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=create-a-new-image-from-a-containers-changes><a class="text-black dark:text-white no-underline hover:underline" href="index.html#create-a-new-image-from-a-containers-changes">Create a new image from a container's changes</a></h4><p><code>POST /commit</code></p><p>Create a new image from a container's changes</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/commit?container=44c004db4b17&amp;comment=message&amp;repo=myrepo HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
     &quot;Hostname&quot;: &quot;&quot;,
     &quot;Domainname&quot;: &quot;&quot;,
     &quot;User&quot;: &quot;&quot;,
     &quot;AttachStdin&quot;: false,
     &quot;AttachStdout&quot;: true,
     &quot;AttachStderr&quot;: true,
     &quot;Tty&quot;: false,
     &quot;OpenStdin&quot;: false,
     &quot;StdinOnce&quot;: false,
     &quot;Env&quot;: null,
     &quot;Cmd&quot;: [
             &quot;date&quot;
     ],
     &quot;Mounts&quot;: [
       {
         &quot;Source&quot;: &quot;/data&quot;,
         &quot;Destination&quot;: &quot;/data&quot;,
         &quot;Mode&quot;: &quot;ro,Z&quot;,
         &quot;RW&quot;: false
       }
     ],
     &quot;Labels&quot;: {
             &quot;key1&quot;: &quot;value1&quot;,
             &quot;key2&quot;: &quot;value2&quot;
      },
     &quot;WorkingDir&quot;: &quot;&quot;,
     &quot;NetworkDisabled&quot;: false,
     &quot;ExposedPorts&quot;: {
             &quot;22/tcp&quot;: {}
     }
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 201 Created
Content-Type: application/json

{&quot;Id&quot;: &quot;596069db4bf5&quot;}
</code></pre><p><strong>JSON parameters</strong>:</p><ul><li><strong>config</strong> - the container's configuration</li></ul><p><strong>Query parameters</strong>:</p><ul><li><strong>container</strong> – source container</li><li><strong>repo</strong> – repository</li><li><strong>tag</strong> – tag</li><li><strong>comment</strong> – commit message</li><li><strong>author</strong> – author (e.g., "John Hannibal Smith
&lt;
<a class=link "https://docs.docker.com/engine/api/v1.24/href">hannibal@a-team.com</a>>")</li><li><strong>pause</strong> – 1/True/true or 0/False/false, whether to pause the container before committing</li><li><strong>changes</strong> – Dockerfile instructions to apply while committing</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=monitor-dockers-events><a class="text-black dark:text-white no-underline hover:underline" href="index.html#monitor-dockers-events">Monitor Docker's events</a></h4><p><code>GET /events</code></p><p>Get container events from docker, in real time via streaming.</p><p>Docker containers report the following events:</p><pre><code>attach, commit, copy, create, destroy, detach, die, exec_create, exec_detach, exec_start, export, health_status, kill, oom, pause, rename, resize, restart, start, stop, top, unpause, update
</code></pre><p>Docker images report the following events:</p><pre><code>delete, import, load, pull, push, save, tag, untag
</code></pre><p>Docker volumes report the following events:</p><pre><code>create, mount, unmount, destroy
</code></pre><p>Docker networks report the following events:</p><pre><code>create, connect, disconnect, destroy
</code></pre><p>Docker daemon report the following event:</p><pre><code>reload
</code></pre><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/events?since=1374067924
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json
Server: Docker/1.12.0 (linux)
Date: Fri, 29 Apr 2016 15:18:06 GMT
Transfer-Encoding: chunked

{
  &quot;status&quot;: &quot;pull&quot;,
  &quot;id&quot;: &quot;alpine:latest&quot;,
  &quot;Type&quot;: &quot;image&quot;,
  &quot;Action&quot;: &quot;pull&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;alpine:latest&quot;,
    &quot;Attributes&quot;: {
      &quot;name&quot;: &quot;alpine&quot;
    }
  },
  &quot;time&quot;: 1461943101,
  &quot;timeNano&quot;: 1461943101301854122
}
{
  &quot;status&quot;: &quot;create&quot;,
  &quot;id&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
  &quot;from&quot;: &quot;alpine&quot;,
  &quot;Type&quot;: &quot;container&quot;,
  &quot;Action&quot;: &quot;create&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
    &quot;Attributes&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-label-value&quot;,
      &quot;image&quot;: &quot;alpine&quot;,
      &quot;name&quot;: &quot;my-container&quot;
    }
  },
  &quot;time&quot;: 1461943101,
  &quot;timeNano&quot;: 1461943101381709551
}
{
  &quot;status&quot;: &quot;attach&quot;,
  &quot;id&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
  &quot;from&quot;: &quot;alpine&quot;,
  &quot;Type&quot;: &quot;container&quot;,
  &quot;Action&quot;: &quot;attach&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
    &quot;Attributes&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-label-value&quot;,
      &quot;image&quot;: &quot;alpine&quot;,
      &quot;name&quot;: &quot;my-container&quot;
    }
  },
  &quot;time&quot;: 1461943101,
  &quot;timeNano&quot;: 1461943101383858412
}
{
  &quot;Type&quot;: &quot;network&quot;,
  &quot;Action&quot;: &quot;connect&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;7dc8ac97d5d29ef6c31b6052f3938c1e8f2749abbd17d1bd1febf2608db1b474&quot;,
    &quot;Attributes&quot;: {
      &quot;container&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
      &quot;name&quot;: &quot;bridge&quot;,
      &quot;type&quot;: &quot;bridge&quot;
    }
  },
  &quot;time&quot;: 1461943101,
  &quot;timeNano&quot;: 1461943101394865557
}
{
  &quot;status&quot;: &quot;start&quot;,
  &quot;id&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
  &quot;from&quot;: &quot;alpine&quot;,
  &quot;Type&quot;: &quot;container&quot;,
  &quot;Action&quot;: &quot;start&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
    &quot;Attributes&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-label-value&quot;,
      &quot;image&quot;: &quot;alpine&quot;,
      &quot;name&quot;: &quot;my-container&quot;
    }
  },
  &quot;time&quot;: 1461943101,
  &quot;timeNano&quot;: 1461943101607533796
}
{
  &quot;status&quot;: &quot;resize&quot;,
  &quot;id&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
  &quot;from&quot;: &quot;alpine&quot;,
  &quot;Type&quot;: &quot;container&quot;,
  &quot;Action&quot;: &quot;resize&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
    &quot;Attributes&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-label-value&quot;,
      &quot;height&quot;: &quot;46&quot;,
      &quot;image&quot;: &quot;alpine&quot;,
      &quot;name&quot;: &quot;my-container&quot;,
      &quot;width&quot;: &quot;204&quot;
    }
  },
  &quot;time&quot;: 1461943101,
  &quot;timeNano&quot;: 1461943101610269268
}
{
  &quot;status&quot;: &quot;die&quot;,
  &quot;id&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
  &quot;from&quot;: &quot;alpine&quot;,
  &quot;Type&quot;: &quot;container&quot;,
  &quot;Action&quot;: &quot;die&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
    &quot;Attributes&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-label-value&quot;,
      &quot;exitCode&quot;: &quot;0&quot;,
      &quot;image&quot;: &quot;alpine&quot;,
      &quot;name&quot;: &quot;my-container&quot;
    }
  },
  &quot;time&quot;: 1461943105,
  &quot;timeNano&quot;: 1461943105079144137
}
{
  &quot;Type&quot;: &quot;network&quot;,
  &quot;Action&quot;: &quot;disconnect&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;7dc8ac97d5d29ef6c31b6052f3938c1e8f2749abbd17d1bd1febf2608db1b474&quot;,
    &quot;Attributes&quot;: {
      &quot;container&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
      &quot;name&quot;: &quot;bridge&quot;,
      &quot;type&quot;: &quot;bridge&quot;
    }
  },
  &quot;time&quot;: 1461943105,
  &quot;timeNano&quot;: 1461943105230860245
}
{
  &quot;status&quot;: &quot;destroy&quot;,
  &quot;id&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
  &quot;from&quot;: &quot;alpine&quot;,
  &quot;Type&quot;: &quot;container&quot;,
  &quot;Action&quot;: &quot;destroy&quot;,
  &quot;Actor&quot;: {
    &quot;ID&quot;: &quot;ede54ee1afda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c743&quot;,
    &quot;Attributes&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-label-value&quot;,
      &quot;image&quot;: &quot;alpine&quot;,
      &quot;name&quot;: &quot;my-container&quot;
    }
  },
  &quot;time&quot;: 1461943105,
  &quot;timeNano&quot;: 1461943105338056026
}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>since</strong> – Timestamp. Show all events created since timestamp and then stream</li><li><strong>until</strong> – Timestamp. Show events created until given timestamp and stop streaming</li><li><strong>filters</strong> – A json encoded value of the filters (a map[string][]string) to process on the event list. Available filters:</li><li><code>container=&lt;string></code>; -- container to filter</li><li><code>event=&lt;string></code>; -- event to filter</li><li><code>image=&lt;string></code>; -- image to filter</li><li><code>label=&lt;string></code>; -- image and container label to filter</li><li><code>type=&lt;string></code>; -- either <code>container</code> or <code>image</code> or <code>volume</code> or <code>network</code> or <code>daemon</code></li><li><code>volume=&lt;string></code>; -- volume to filter</li><li><code>network=&lt;string></code>; -- network to filter</li><li><code>daemon=&lt;string></code>; -- daemon name or id to filter</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> - bad parameter</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=get-a-tarball-containing-all-images-in-a-repository><a class="text-black dark:text-white no-underline hover:underline" href="index.html#get-a-tarball-containing-all-images-in-a-repository">Get a tarball containing all images in a repository</a></h4><p><code>GET /images/(name)/get</code></p><p>Get a tarball containing all images and metadata for the repository specified
by <code>name</code>.</p><p>If <code>name</code> is a specific name and tag (e.g. ubuntu:latest), then only that image
(and its parents) are returned. If <code>name</code> is an image ID, similarly only that
image (and its parents) are returned, but with the exclusion of the
'repositories' file in the tarball, as there were no image names referenced.</p><p>See the
<a class=link href="index.html#image-tarball-format">image tarball format</a> for more details.</p><p><strong>Example request</strong></p><pre><code>GET /v1.24/images/ubuntu/get
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/x-tar

Binary data stream
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=get-a-tarball-containing-all-images><a class="text-black dark:text-white no-underline hover:underline" href="index.html#get-a-tarball-containing-all-images">Get a tarball containing all images</a></h4><p><code>GET /images/get</code></p><p>Get a tarball containing all images and metadata for one or more repositories.</p><p>For each value of the <code>names</code> parameter: if it is a specific name and tag (e.g.
<code>ubuntu:latest</code>), then only that image (and its parents) are returned; if it is
an image ID, similarly only that image (and its parents) are returned and there
would be no names referenced in the 'repositories' file for this image ID.</p><p>See the
<a class=link href="index.html#image-tarball-format">image tarball format</a> for more details.</p><p><strong>Example request</strong></p><pre><code>GET /v1.24/images/get?names=myname%2Fmyapp%3Alatest&amp;names=busybox
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/x-tar

Binary data stream
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=load-a-tarball-with-a-set-of-images-and-tags-into-docker><a class="text-black dark:text-white no-underline hover:underline" href="index.html#load-a-tarball-with-a-set-of-images-and-tags-into-docker">Load a tarball with a set of images and tags into docker</a></h4><p><code>POST /images/load</code></p><p>Load a set of images and tags into a Docker repository.
See the
<a class=link href="index.html#image-tarball-format">image tarball format</a> for more details.</p><p><strong>Example request</strong></p><pre><code>POST /v1.24/images/load
Content-Type: application/x-tar
Content-Length: 12345

Tarball in body
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked

{&quot;status&quot;:&quot;Loading layer&quot;,&quot;progressDetail&quot;:{&quot;current&quot;:32768,&quot;total&quot;:1292800},&quot;progress&quot;:&quot;[=                                                 ] 32.77 kB/1.293 MB&quot;,&quot;id&quot;:&quot;8ac8bfaff55a&quot;}
{&quot;status&quot;:&quot;Loading layer&quot;,&quot;progressDetail&quot;:{&quot;current&quot;:65536,&quot;total&quot;:1292800},&quot;progress&quot;:&quot;[==                                                ] 65.54 kB/1.293 MB&quot;,&quot;id&quot;:&quot;8ac8bfaff55a&quot;}
{&quot;status&quot;:&quot;Loading layer&quot;,&quot;progressDetail&quot;:{&quot;current&quot;:98304,&quot;total&quot;:1292800},&quot;progress&quot;:&quot;[===                                               ]  98.3 kB/1.293 MB&quot;,&quot;id&quot;:&quot;8ac8bfaff55a&quot;}
{&quot;status&quot;:&quot;Loading layer&quot;,&quot;progressDetail&quot;:{&quot;current&quot;:131072,&quot;total&quot;:1292800},&quot;progress&quot;:&quot;[=====                                             ] 131.1 kB/1.293 MB&quot;,&quot;id&quot;:&quot;8ac8bfaff55a&quot;}
...
{&quot;stream&quot;:&quot;Loaded image: busybox:latest\n&quot;}
</code></pre><p><strong>Example response</strong>:</p><p>If the "quiet" query parameter is set to <code>true</code> / <code>1</code> (<code>?quiet=1</code>), progress
details are suppressed, and only a confirmation message is returned once the
action completes.</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked

{&quot;stream&quot;:&quot;Loaded image: busybox:latest\n&quot;}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>quiet</strong> – Boolean value, suppress progress details during load. Defaults
to <code>0</code> / <code>false</code> if omitted.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=image-tarball-format><a class="text-black dark:text-white no-underline hover:underline" href="index.html#image-tarball-format">Image tarball format</a></h4><p>An image tarball contains one directory per image layer (named using its long ID),
each containing these files:</p><ul><li><code>VERSION</code>: currently <code>1.0</code> - the file format version</li><li><code>json</code>: detailed layer information, similar to <code>docker inspect layer_id</code></li><li><code>layer.tar</code>: A tarfile containing the filesystem changes in this layer</li></ul><p>The <code>layer.tar</code> file contains <code>aufs</code> style <code>.wh..wh.aufs</code> files and directories
for storing attribute changes and deletions.</p><p>If the tarball defines a repository, the tarball should also include a <code>repositories</code> file at
the root that contains a list of repository and tag names mapped to layer IDs.</p><div class="group relative"><button x-data="{ code: 'eyJoZWxsby13b3JsZCI6CiAgICB7ImxhdGVzdCI6ICI1NjVhOWQ2OGE3M2Y2NzA2ODYyYmZlODQwOWE3ZjY1OTc3NmQ0ZDYwYThkMDk2ZWI0YTNjYmNlNjk5OWNjMmExIn0KfQ==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>{&#34;hello-world&#34;:
    {&#34;latest&#34;: &#34;565a9d68a73f6706862bfe8409a7f659776d4d60a8d096eb4a3cbce6999cc2a1&#34;}
}</code></pre></div></div><h4 class=scroll-mt-20 id=exec-create><a class="text-black dark:text-white no-underline hover:underline" href="index.html#exec-create">Exec Create</a></h4><p><code>POST /containers/(id or name)/exec</code></p><p>Sets up an exec instance in a running container <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/containers/e90e34656806/exec HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &quot;AttachStdin&quot;: true,
  &quot;AttachStdout&quot;: true,
  &quot;AttachStderr&quot;: true,
  &quot;Cmd&quot;: [&quot;sh&quot;],
  &quot;DetachKeys&quot;: &quot;ctrl-p,ctrl-q&quot;,
  &quot;Privileged&quot;: true,
  &quot;Tty&quot;: true,
  &quot;User&quot;: &quot;123:456&quot;
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 201 Created
Content-Type: application/json

{
     &quot;Id&quot;: &quot;f90e34656806&quot;,
     &quot;Warnings&quot;:[]
}
</code></pre><p><strong>JSON parameters</strong>:</p><ul><li><strong>AttachStdin</strong> - Boolean value, attaches to <code>stdin</code> of the <code>exec</code> command.</li><li><strong>AttachStdout</strong> - Boolean value, attaches to <code>stdout</code> of the <code>exec</code> command.</li><li><strong>AttachStderr</strong> - Boolean value, attaches to <code>stderr</code> of the <code>exec</code> command.</li><li><strong>DetachKeys</strong> – Override the key sequence for detaching a
container. Format is a single character <code>[a-Z]</code> or <code>ctrl-&lt;value></code>
where <code>&lt;value></code> is one of: <code>a-z</code>, <code>@</code>, <code>^</code>, <code>[</code>, <code>,</code> or <code>_</code>.</li><li><strong>Tty</strong> - Boolean value to allocate a pseudo-TTY.</li><li><strong>Cmd</strong> - Command to run specified as a string or an array of strings.</li><li><strong>Privileged</strong> - Boolean value, runs the exec process with extended privileges.</li><li><strong>User</strong> - A string value specifying the user, and optionally, group to run
the exec process inside the container. Format is one of: <code>"user"</code>,
<code>"user:group"</code>, <code>"uid"</code>, or <code>"uid:gid"</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> – no error</li><li><strong>404</strong> – no such container</li><li><strong>409</strong> - container is paused</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=exec-start><a class="text-black dark:text-white no-underline hover:underline" href="index.html#exec-start">Exec Start</a></h4><p><code>POST /exec/(id)/start</code></p><p>Starts a previously set up <code>exec</code> instance <code>id</code>. If <code>detach</code> is true, this API
returns after starting the <code>exec</code> command. Otherwise, this API sets up an
interactive session with the <code>exec</code> command.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/exec/e90e34656806/start HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
 &quot;Detach&quot;: false,
 &quot;Tty&quot;: false
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/vnd.docker.raw-stream

{% raw %}
{{ STREAM }}
{% endraw %}
</code></pre><p><strong>JSON parameters</strong>:</p><ul><li><strong>Detach</strong> - Detach from the <code>exec</code> command.</li><li><strong>Tty</strong> - Boolean value to allocate a pseudo-TTY.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such exec instance</li><li><strong>409</strong> - container is paused</li></ul><p><strong>Stream details</strong>:</p><p>Similar to the stream behavior of <code>POST /containers/(id or name)/attach</code> API</p><h4 class=scroll-mt-20 id=exec-resize><a class="text-black dark:text-white no-underline hover:underline" href="index.html#exec-resize">Exec Resize</a></h4><p><code>POST /exec/(id)/resize</code></p><p>Resizes the <code>tty</code> session used by the <code>exec</code> command <code>id</code>. The unit is number of characters.
This API is valid only if <code>tty</code> was specified as part of creating and starting the <code>exec</code> command.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/exec/e90e34656806/resize?h=40&amp;w=80 HTTP/1.1
Content-Type: text/plain
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 201 Created
Content-Type: text/plain
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>h</strong> – height of <code>tty</code> session</li><li><strong>w</strong> – width</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> – no error</li><li><strong>404</strong> – no such exec instance</li></ul><h4 class=scroll-mt-20 id=exec-inspect><a class="text-black dark:text-white no-underline hover:underline" href="index.html#exec-inspect">Exec Inspect</a></h4><p><code>GET /exec/(id)/json</code></p><p>Return low-level information about the <code>exec</code> command <code>id</code>.</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/exec/11fb006128e8ceb3942e7c58d77750f24210e35f879dd204ac975c184b820b39/json HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &quot;CanRemove&quot;: false,
  &quot;ContainerID&quot;: &quot;b53ee82b53a40c7dca428523e34f741f3abc51d9f297a14ff874bf761b995126&quot;,
  &quot;DetachKeys&quot;: &quot;&quot;,
  &quot;ExitCode&quot;: 2,
  &quot;ID&quot;: &quot;f33bbfb39f5b142420f4759b2348913bd4a8d1a6d7fd56499cb41a1bb91d7b3b&quot;,
  &quot;OpenStderr&quot;: true,
  &quot;OpenStdin&quot;: true,
  &quot;OpenStdout&quot;: true,
  &quot;ProcessConfig&quot;: {
    &quot;arguments&quot;: [
      &quot;-c&quot;,
      &quot;exit 2&quot;
    ],
    &quot;entrypoint&quot;: &quot;sh&quot;,
    &quot;privileged&quot;: false,
    &quot;tty&quot;: true,
    &quot;user&quot;: &quot;1000&quot;
  },
  &quot;Running&quot;: false
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such exec instance</li><li><strong>500</strong> - server error</li></ul><h3 class=scroll-mt-20 id=34-volumes><a class="text-black dark:text-white no-underline hover:underline" href="index.html#34-volumes">3.4 Volumes</a></h3><h4 class=scroll-mt-20 id=list-volumes><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-volumes">List volumes</a></h4><p><code>GET /volumes</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/volumes HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &quot;Volumes&quot;: [
    {
      &quot;Name&quot;: &quot;tardis&quot;,
      &quot;Driver&quot;: &quot;local&quot;,
      &quot;Mountpoint&quot;: &quot;/var/lib/docker/volumes/tardis&quot;,
      &quot;Labels&quot;: null,
      &quot;Scope&quot;: &quot;local&quot;
    }
  ],
  &quot;Warnings&quot;: []
}
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>filters</strong> - JSON encoded value of the filters (a <code>map[string][]string</code>) to process on the volumes list. Available filters:<ul><li><code>name=&lt;volume-name></code> Matches all or part of a volume name.</li><li><code>dangling=&lt;boolean></code> When set to <code>true</code> (or <code>1</code>), returns all volumes that are "dangling" (not in use by a container). When set to <code>false</code> (or <code>0</code>), only volumes that are in use by one or more containers are returned.</li><li><code>driver=&lt;volume-driver-name></code> Matches all or part of a volume driver name.</li></ul></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=create-a-volume><a class="text-black dark:text-white no-underline hover:underline" href="index.html#create-a-volume">Create a volume</a></h4><p><code>POST /volumes/create</code></p><p>Create a volume</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/volumes/create HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &quot;Name&quot;: &quot;tardis&quot;,
  &quot;Labels&quot;: {
    &quot;com.example.some-label&quot;: &quot;some-value&quot;,
    &quot;com.example.some-other-label&quot;: &quot;some-other-value&quot;
  },
  &quot;Driver&quot;: &quot;custom&quot;
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 201 Created
Content-Type: application/json

{
  &quot;Name&quot;: &quot;tardis&quot;,
  &quot;Driver&quot;: &quot;custom&quot;,
  &quot;Mountpoint&quot;: &quot;/var/lib/docker/volumes/tardis&quot;,
  &quot;Status&quot;: {
    &quot;hello&quot;: &quot;world&quot;
  },
  &quot;Labels&quot;: {
    &quot;com.example.some-label&quot;: &quot;some-value&quot;,
    &quot;com.example.some-other-label&quot;: &quot;some-other-value&quot;
  },
  &quot;Scope&quot;: &quot;local&quot;
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> - no error</li><li><strong>500</strong> - server error</li></ul><p><strong>JSON parameters</strong>:</p><ul><li><strong>Name</strong> - The new volume's name. If not specified, Docker generates a name.</li><li><strong>Driver</strong> - Name of the volume driver to use. Defaults to <code>local</code> for the name.</li><li><strong>DriverOpts</strong> - A mapping of driver options and values. These options are
passed directly to the driver and are driver specific.</li><li><strong>Labels</strong> - Labels to set on the volume, specified as a map: <code>{"key":"value","key2":"value2"}</code></li></ul><p><strong>JSON fields in response</strong>:</p><p>Refer to the
<a class=link href="index.html#inspect-a-volume">inspect a volume</a> section or details about the
JSON fields returned in the response.</p><h4 class=scroll-mt-20 id=inspect-a-volume><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-a-volume">Inspect a volume</a></h4><p><code>GET /volumes/(name)</code></p><p>Return low-level information on the volume <code>name</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/volumes/tardis
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &quot;Name&quot;: &quot;tardis&quot;,
  &quot;Driver&quot;: &quot;custom&quot;,
  &quot;Mountpoint&quot;: &quot;/var/lib/docker/volumes/tardis/_data&quot;,
  &quot;Status&quot;: {
    &quot;hello&quot;: &quot;world&quot;
  },
  &quot;Labels&quot;: {
      &quot;com.example.some-label&quot;: &quot;some-value&quot;,
      &quot;com.example.some-other-label&quot;: &quot;some-other-value&quot;
  },
  &quot;Scope&quot;: &quot;local&quot;
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>404</strong> - no such volume</li><li><strong>500</strong> - server error</li></ul><p><strong>JSON fields in response</strong>:</p><p>The following fields can be returned in the API response. Empty fields, or
fields that are not supported by the volume's driver may be omitted in the
response.</p><ul><li><strong>Name</strong> - Name of the volume.</li><li><strong>Driver</strong> - Name of the volume driver used by the volume.</li><li><strong>Mountpoint</strong> - Mount path of the volume on the host.</li><li><strong>Status</strong> - Low-level details about the volume, provided by the volume driver.
Details are returned as a map with key/value pairs: <code>{"key":"value","key2":"value2"}</code>.
The <code>Status</code> field is optional, and is omitted if the volume driver does not
support this feature.</li><li><strong>Labels</strong> - Labels set on the volume, specified as a map: <code>{"key":"value","key2":"value2"}</code>.</li><li><strong>Scope</strong> - Scope describes the level at which the volume exists, can be one of
<code>global</code> for cluster-wide or <code>local</code> for machine level. The default is <code>local</code>.</li></ul><h4 class=scroll-mt-20 id=remove-a-volume><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-a-volume">Remove a volume</a></h4><p><code>DELETE /volumes/(name)</code></p><p>Instruct the driver to remove the volume (<code>name</code>).</p><p><strong>Example request</strong>:</p><pre><code>DELETE /v1.24/volumes/tardis HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> - no error</li><li><strong>404</strong> - no such volume or volume driver</li><li><strong>409</strong> - volume is in use and cannot be removed</li><li><strong>500</strong> - server error</li></ul><h3 class=scroll-mt-20 id=35-networks><a class="text-black dark:text-white no-underline hover:underline" href="index.html#35-networks">3.5 Networks</a></h3><h4 class=scroll-mt-20 id=list-networks><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-networks">List networks</a></h4><p><code>GET /networks</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/networks?filters={&quot;type&quot;:{&quot;custom&quot;:true}} HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgoKWwogIHsKICAgICJOYW1lIjogImJyaWRnZSIsCiAgICAiSWQiOiAiZjJkZTM5ZGY0MTcxYjBkYzgwMWU4MDAyZDFkOTk5Yjc3MjU2OTgzZGZjNjMwNDFjMGYzNDAzMGFhMzk3NzU2NiIsCiAgICAiU2NvcGUiOiAibG9jYWwiLAogICAgIkRyaXZlciI6ICJicmlkZ2UiLAogICAgIkVuYWJsZUlQdjYiOiBmYWxzZSwKICAgICJJbnRlcm5hbCI6IGZhbHNlLAogICAgIklQQU0iOiB7CiAgICAgICJEcml2ZXIiOiAiZGVmYXVsdCIsCiAgICAgICJDb25maWciOiBbCiAgICAgICAgewogICAgICAgICAgIlN1Ym5ldCI6ICIxNzIuMTcuMC4wLzE2IgogICAgICAgIH0KICAgICAgXQogICAgfSwKICAgICJDb250YWluZXJzIjogewogICAgICAiMzliNjkyMjZmOWQ3OWY1NjM0NDg1ZmIyMzZhMjNiMmZlNGU5NmEwYTk0MTI4MzkwYTdmYmJjYzE2NzA2NTg2NyI6IHsKICAgICAgICAiRW5kcG9pbnRJRCI6ICJlZDI0MTlhOTdjMWQ5OTU0ZDA1YjQ2ZTQ2MmU3MDAyZWE1NTJmMjE2ZTliMTM2YjgwYTdkYjhkOThiNDQyZWRhIiwKICAgICAgICAiTWFjQWRkcmVzcyI6ICIwMjo0MjphYzoxMTowMDowMiIsCiAgICAgICAgIklQdjRBZGRyZXNzIjogIjE3Mi4xNy4wLjIvMTYiLAogICAgICAgICJJUHY2QWRkcmVzcyI6ICIiCiAgICAgIH0KICAgIH0sCiAgICAiT3B0aW9ucyI6IHsKICAgICAgImNvbS5kb2NrZXIubmV0d29yay5icmlkZ2UuZGVmYXVsdF9icmlkZ2UiOiAidHJ1ZSIsCiAgICAgICJjb20uZG9ja2VyLm5ldHdvcmsuYnJpZGdlLmVuYWJsZV9pY2MiOiAidHJ1ZSIsCiAgICAgICJjb20uZG9ja2VyLm5ldHdvcmsuYnJpZGdlLmVuYWJsZV9pcF9tYXNxdWVyYWRlIjogInRydWUiLAogICAgICAiY29tLmRvY2tlci5uZXR3b3JrLmJyaWRnZS5ob3N0X2JpbmRpbmdfaXB2NCI6ICIwLjAuMC4wIiwKICAgICAgImNvbS5kb2NrZXIubmV0d29yay5icmlkZ2UubmFtZSI6ICJkb2NrZXIwIiwKICAgICAgImNvbS5kb2NrZXIubmV0d29yay5kcml2ZXIubXR1IjogIjE1MDAiCiAgICB9CiAgfSwKICB7CiAgICAiTmFtZSI6ICJub25lIiwKICAgICJJZCI6ICJlMDg2YTM4OTNiMDVhYjY5MjQyZDNjNDRlNDk0ODNhM2JiYmQzYTI2YjQ2YmFhOGY2MWFiNzk3YzEwODhkNzk0IiwKICAgICJTY29wZSI6ICJsb2NhbCIsCiAgICAiRHJpdmVyIjogIm51bGwiLAogICAgIkVuYWJsZUlQdjYiOiBmYWxzZSwKICAgICJJbnRlcm5hbCI6IGZhbHNlLAogICAgIklQQU0iOiB7CiAgICAgICJEcml2ZXIiOiAiZGVmYXVsdCIsCiAgICAgICJDb25maWciOiBbXQogICAgfSwKICAgICJDb250YWluZXJzIjoge30sCiAgICAiT3B0aW9ucyI6IHt9CiAgfSwKICB7CiAgICAiTmFtZSI6ICJob3N0IiwKICAgICJJZCI6ICIxM2U4NzEyMzVjNjc3ZjE5NmM0ZTFlY2ViYjlkYzczM2I5YjJkMmFiNTg5ZTMwYzUzOWVmZWRhODRhMjQyMTVlIiwKICAgICJTY29wZSI6ICJsb2NhbCIsCiAgICAiRHJpdmVyIjogImhvc3QiLAogICAgIkVuYWJsZUlQdjYiOiBmYWxzZSwKICAgICJJbnRlcm5hbCI6IGZhbHNlLAogICAgIklQQU0iOiB7CiAgICAgICJEcml2ZXIiOiAiZGVmYXVsdCIsCiAgICAgICJDb25maWciOiBbXQogICAgfSwKICAgICJDb250YWluZXJzIjoge30sCiAgICAiT3B0aW9ucyI6IHt9CiAgfQpd', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    &#34;Name&#34;: &#34;bridge&#34;,
    &#34;Id&#34;: &#34;f2de39df4171b0dc801e8002d1d999b77256983dfc63041c0f34030aa3977566&#34;,
    &#34;Scope&#34;: &#34;local&#34;,
    &#34;Driver&#34;: &#34;bridge&#34;,
    &#34;EnableIPv6&#34;: false,
    &#34;Internal&#34;: false,
    &#34;IPAM&#34;: {
      &#34;Driver&#34;: &#34;default&#34;,
      &#34;Config&#34;: [
        {
          &#34;Subnet&#34;: &#34;172.17.0.0/16&#34;
        }
      ]
    },
    &#34;Containers&#34;: {
      &#34;39b69226f9d79f5634485fb236a23b2fe4e96a0a94128390a7fbbcc167065867&#34;: {
        &#34;EndpointID&#34;: &#34;ed2419a97c1d9954d05b46e462e7002ea552f216e9b136b80a7db8d98b442eda&#34;,
        &#34;MacAddress&#34;: &#34;02:42:ac:11:00:02&#34;,
        &#34;IPv4Address&#34;: &#34;172.17.0.2/16&#34;,
        &#34;IPv6Address&#34;: &#34;&#34;
      }
    },
    &#34;Options&#34;: {
      &#34;com.docker.network.bridge.default_bridge&#34;: &#34;true&#34;,
      &#34;com.docker.network.bridge.enable_icc&#34;: &#34;true&#34;,
      &#34;com.docker.network.bridge.enable_ip_masquerade&#34;: &#34;true&#34;,
      &#34;com.docker.network.bridge.host_binding_ipv4&#34;: &#34;0.0.0.0&#34;,
      &#34;com.docker.network.bridge.name&#34;: &#34;docker0&#34;,
      &#34;com.docker.network.driver.mtu&#34;: &#34;1500&#34;
    }
  },
  {
    &#34;Name&#34;: &#34;none&#34;,
    &#34;Id&#34;: &#34;e086a3893b05ab69242d3c44e49483a3bbbd3a26b46baa8f61ab797c1088d794&#34;,
    &#34;Scope&#34;: &#34;local&#34;,
    &#34;Driver&#34;: &#34;null&#34;,
    &#34;EnableIPv6&#34;: false,
    &#34;Internal&#34;: false,
    &#34;IPAM&#34;: {
      &#34;Driver&#34;: &#34;default&#34;,
      &#34;Config&#34;: []
    },
    &#34;Containers&#34;: {},
    &#34;Options&#34;: {}
  },
  {
    &#34;Name&#34;: &#34;host&#34;,
    &#34;Id&#34;: &#34;13e871235c677f196c4e1ecebb9dc733b9b2d2ab589e30c539efeda84a24215e&#34;,
    &#34;Scope&#34;: &#34;local&#34;,
    &#34;Driver&#34;: &#34;host&#34;,
    &#34;EnableIPv6&#34;: false,
    &#34;Internal&#34;: false,
    &#34;IPAM&#34;: {
      &#34;Driver&#34;: &#34;default&#34;,
      &#34;Config&#34;: []
    },
    &#34;Containers&#34;: {},
    &#34;Options&#34;: {}
  }
]</code></pre></div></div><p><strong>Query parameters</strong>:</p><ul><li><strong>filters</strong> - JSON encoded network list filter. The filter value is one of:<ul><li><code>driver=&lt;driver-name></code> Matches a network's driver.</li><li><code>id=&lt;network-id></code> Matches all or part of a network id.</li><li><code>label=&lt;key></code> or <code>label=&lt;key>=&lt;value></code> of a network label.</li><li><code>name=&lt;network-name></code> Matches all or part of a network name.</li><li><code>type=["custom"|"builtin"]</code> Filters networks by type. The <code>custom</code> keyword returns all user-defined networks.</li></ul></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=inspect-network><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-network">Inspect network</a></h4><p><code>GET /networks/(id or name)</code></p><p>Return low-level information on the network <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/networks/7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgoKewogICJOYW1lIjogIm5ldDAxIiwKICAiSWQiOiAiN2Q4NmQzMWIxNDc4ZTdjY2E5ZWJlZDdlNzNhYTBmZGVlYzQ2YzVjYTI5NDk3NDMxZDMwMDdkMmQ5ZTE1ZWQ5OSIsCiAgIlNjb3BlIjogImxvY2FsIiwKICAiRHJpdmVyIjogImJyaWRnZSIsCiAgIkVuYWJsZUlQdjYiOiBmYWxzZSwKICAiSVBBTSI6IHsKICAgICJEcml2ZXIiOiAiZGVmYXVsdCIsCiAgICAiQ29uZmlnIjogWwogICAgICB7CiAgICAgICAgIlN1Ym5ldCI6ICIxNzIuMTkuMC4wLzE2IiwKICAgICAgICAiR2F0ZXdheSI6ICIxNzIuMTkuMC4xIgogICAgICB9CiAgICBdLAogICAgIk9wdGlvbnMiOiB7CiAgICAgICAgImZvbyI6ICJiYXIiCiAgICB9CiAgfSwKICAiSW50ZXJuYWwiOiBmYWxzZSwKICAiQ29udGFpbmVycyI6IHsKICAgICIxOWE0ZDVkNjg3ZGIyNTIwMzM1MWVkNzlkNDc4OTQ2Zjg2MTI1OGYwMThmZTM4NGYyMjlmMmVmYTRiMjM1MTNjIjogewogICAgICAiTmFtZSI6ICJ0ZXN0IiwKICAgICAgIkVuZHBvaW50SUQiOiAiNjI4Y2FkYjhiY2I5MmRlMTA3YjJhMWU1MTZjYmZmZTQ2M2UzMjFmNTQ4ZmViMzc2OTdjY2UwMGFkNjk0ZjIxYSIsCiAgICAgICJNYWNBZGRyZXNzIjogIjAyOjQyOmFjOjEzOjAwOjAyIiwKICAgICAgIklQdjRBZGRyZXNzIjogIjE3Mi4xOS4wLjIvMTYiLAogICAgICAiSVB2NkFkZHJlc3MiOiAiIgogICAgfQogIH0sCiAgIk9wdGlvbnMiOiB7CiAgICAiY29tLmRvY2tlci5uZXR3b3JrLmJyaWRnZS5kZWZhdWx0X2JyaWRnZSI6ICJ0cnVlIiwKICAgICJjb20uZG9ja2VyLm5ldHdvcmsuYnJpZGdlLmVuYWJsZV9pY2MiOiAidHJ1ZSIsCiAgICAiY29tLmRvY2tlci5uZXR3b3JrLmJyaWRnZS5lbmFibGVfaXBfbWFzcXVlcmFkZSI6ICJ0cnVlIiwKICAgICJjb20uZG9ja2VyLm5ldHdvcmsuYnJpZGdlLmhvc3RfYmluZGluZ19pcHY0IjogIjAuMC4wLjAiLAogICAgImNvbS5kb2NrZXIubmV0d29yay5icmlkZ2UubmFtZSI6ICJkb2NrZXIwIiwKICAgICJjb20uZG9ja2VyLm5ldHdvcmsuZHJpdmVyLm10dSI6ICIxNTAwIgogIH0sCiAgIkxhYmVscyI6IHsKICAgICJjb20uZXhhbXBsZS5zb21lLWxhYmVsIjogInNvbWUtdmFsdWUiLAogICAgImNvbS5leGFtcGxlLnNvbWUtb3RoZXItbGFiZWwiOiAic29tZS1vdGhlci12YWx1ZSIKICB9Cn0=', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &#34;Name&#34;: &#34;net01&#34;,
  &#34;Id&#34;: &#34;7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99&#34;,
  &#34;Scope&#34;: &#34;local&#34;,
  &#34;Driver&#34;: &#34;bridge&#34;,
  &#34;EnableIPv6&#34;: false,
  &#34;IPAM&#34;: {
    &#34;Driver&#34;: &#34;default&#34;,
    &#34;Config&#34;: [
      {
        &#34;Subnet&#34;: &#34;172.19.0.0/16&#34;,
        &#34;Gateway&#34;: &#34;172.19.0.1&#34;
      }
    ],
    &#34;Options&#34;: {
        &#34;foo&#34;: &#34;bar&#34;
    }
  },
  &#34;Internal&#34;: false,
  &#34;Containers&#34;: {
    &#34;19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c&#34;: {
      &#34;Name&#34;: &#34;test&#34;,
      &#34;EndpointID&#34;: &#34;628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a&#34;,
      &#34;MacAddress&#34;: &#34;02:42:ac:13:00:02&#34;,
      &#34;IPv4Address&#34;: &#34;172.19.0.2/16&#34;,
      &#34;IPv6Address&#34;: &#34;&#34;
    }
  },
  &#34;Options&#34;: {
    &#34;com.docker.network.bridge.default_bridge&#34;: &#34;true&#34;,
    &#34;com.docker.network.bridge.enable_icc&#34;: &#34;true&#34;,
    &#34;com.docker.network.bridge.enable_ip_masquerade&#34;: &#34;true&#34;,
    &#34;com.docker.network.bridge.host_binding_ipv4&#34;: &#34;0.0.0.0&#34;,
    &#34;com.docker.network.bridge.name&#34;: &#34;docker0&#34;,
    &#34;com.docker.network.driver.mtu&#34;: &#34;1500&#34;
  },
  &#34;Labels&#34;: {
    &#34;com.example.some-label&#34;: &#34;some-value&#34;,
    &#34;com.example.some-other-label&#34;: &#34;some-other-value&#34;
  }
}</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>404</strong> - network not found</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=create-a-network><a class="text-black dark:text-white no-underline hover:underline" href="index.html#create-a-network">Create a network</a></h4><p><code>POST /networks/create</code></p><p>Create a network</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'UE9TVCAvdjEuMjQvbmV0d29ya3MvY3JlYXRlIEhUVFAvMS4xCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpDb250ZW50LUxlbmd0aDogMTIzNDUKCnsKICAiTmFtZSI6Imlzb2xhdGVkX253IiwKICAiQ2hlY2tEdXBsaWNhdGUiOnRydWUsCiAgIkRyaXZlciI6ImJyaWRnZSIsCiAgIkVuYWJsZUlQdjYiOiB0cnVlLAogICJJUEFNIjp7CiAgICAiRHJpdmVyIjogImRlZmF1bHQiLAogICAgIkNvbmZpZyI6WwogICAgICB7CiAgICAgICAgIlN1Ym5ldCI6IjE3Mi4yMC4wLjAvMTYiLAogICAgICAgICJJUFJhbmdlIjoiMTcyLjIwLjEwLjAvMjQiLAogICAgICAgICJHYXRld2F5IjoiMTcyLjIwLjEwLjExIgogICAgICB9LAogICAgICB7CiAgICAgICAgIlN1Ym5ldCI6IjIwMDE6ZGI4OmFiY2Q6Oi82NCIsCiAgICAgICAgIkdhdGV3YXkiOiIyMDAxOmRiODphYmNkOjoxMDExIgogICAgICB9CiAgICBdLAogICAgIk9wdGlvbnMiOiB7CiAgICAgICJmb28iOiAiYmFyIgogICAgfQogIH0sCiAgIkludGVybmFsIjp0cnVlLAogICJPcHRpb25zIjogewogICAgImNvbS5kb2NrZXIubmV0d29yay5icmlkZ2UuZGVmYXVsdF9icmlkZ2UiOiAidHJ1ZSIsCiAgICAiY29tLmRvY2tlci5uZXR3b3JrLmJyaWRnZS5lbmFibGVfaWNjIjogInRydWUiLAogICAgImNvbS5kb2NrZXIubmV0d29yay5icmlkZ2UuZW5hYmxlX2lwX21hc3F1ZXJhZGUiOiAidHJ1ZSIsCiAgICAiY29tLmRvY2tlci5uZXR3b3JrLmJyaWRnZS5ob3N0X2JpbmRpbmdfaXB2NCI6ICIwLjAuMC4wIiwKICAgICJjb20uZG9ja2VyLm5ldHdvcmsuYnJpZGdlLm5hbWUiOiAiZG9ja2VyMCIsCiAgICAiY29tLmRvY2tlci5uZXR3b3JrLmRyaXZlci5tdHUiOiAiMTUwMCIKICB9LAogICJMYWJlbHMiOiB7CiAgICAiY29tLmV4YW1wbGUuc29tZS1sYWJlbCI6ICJzb21lLXZhbHVlIiwKICAgICJjb20uZXhhbXBsZS5zb21lLW90aGVyLWxhYmVsIjogInNvbWUtb3RoZXItdmFsdWUiCiAgfQp9', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>POST /v1.24/networks/create HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &#34;Name&#34;:&#34;isolated_nw&#34;,
  &#34;CheckDuplicate&#34;:true,
  &#34;Driver&#34;:&#34;bridge&#34;,
  &#34;EnableIPv6&#34;: true,
  &#34;IPAM&#34;:{
    &#34;Driver&#34;: &#34;default&#34;,
    &#34;Config&#34;:[
      {
        &#34;Subnet&#34;:&#34;172.20.0.0/16&#34;,
        &#34;IPRange&#34;:&#34;172.20.10.0/24&#34;,
        &#34;Gateway&#34;:&#34;172.20.10.11&#34;
      },
      {
        &#34;Subnet&#34;:&#34;2001:db8:abcd::/64&#34;,
        &#34;Gateway&#34;:&#34;2001:db8:abcd::1011&#34;
      }
    ],
    &#34;Options&#34;: {
      &#34;foo&#34;: &#34;bar&#34;
    }
  },
  &#34;Internal&#34;:true,
  &#34;Options&#34;: {
    &#34;com.docker.network.bridge.default_bridge&#34;: &#34;true&#34;,
    &#34;com.docker.network.bridge.enable_icc&#34;: &#34;true&#34;,
    &#34;com.docker.network.bridge.enable_ip_masquerade&#34;: &#34;true&#34;,
    &#34;com.docker.network.bridge.host_binding_ipv4&#34;: &#34;0.0.0.0&#34;,
    &#34;com.docker.network.bridge.name&#34;: &#34;docker0&#34;,
    &#34;com.docker.network.driver.mtu&#34;: &#34;1500&#34;
  },
  &#34;Labels&#34;: {
    &#34;com.example.some-label&#34;: &#34;some-value&#34;,
    &#34;com.example.some-other-label&#34;: &#34;some-other-value&#34;
  }
}</code></pre></div></div><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAxIENyZWF0ZWQKQ29udGVudC1UeXBlOiBhcHBsaWNhdGlvbi9qc29uCgp7CiAgIklkIjogIjIyYmU5M2Q1YmFiYjA4OWM1YWFiOGRiYzM2OTA0MmZhZDQ4ZmY3OTE1ODRjYTJkYTIxMDBkYjgzN2ExYzdjMzAiLAogICJXYXJuaW5nIjogIiIKfQ==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 201 Created
Content-Type: application/json

{
  &#34;Id&#34;: &#34;22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30&#34;,
  &#34;Warning&#34;: &#34;&#34;
}</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> - no error</li><li><strong>403</strong> - operation not supported for pre-defined networks</li><li><strong>404</strong> - plugin not found</li><li><strong>500</strong> - server error</li></ul><p><strong>JSON parameters</strong>:</p><ul><li><strong>Name</strong> - The new network's name. this is a mandatory field</li><li><strong>CheckDuplicate</strong> - Requests daemon to check for networks with same name. Defaults to <code>false</code>.
Since Network is primarily keyed based on a random ID and not on the name,
and network name is strictly a user-friendly alias to the network
which is uniquely identified using ID, there is no guaranteed way to check for duplicates.
This parameter CheckDuplicate is there to provide a best effort checking of any networks
which has the same name but it is not guaranteed to catch all name collisions.</li><li><strong>Driver</strong> - Name of the network driver plugin to use. Defaults to <code>bridge</code> driver</li><li><strong>Internal</strong> - Restrict external access to the network</li><li><strong>IPAM</strong> - Optional custom IP scheme for the network<ul><li><strong>Driver</strong> - Name of the IPAM driver to use. Defaults to <code>default</code> driver</li><li><strong>Config</strong> - List of IPAM configuration options, specified as a map:
<code>{"Subnet": &lt;CIDR>, "IPRange": &lt;CIDR>, "Gateway": &lt;IP address>, "AuxAddress": &lt;device_name:IP address>}</code></li><li><strong>Options</strong> - Driver-specific options, specified as a map: <code>{"option":"value" [,"option2":"value2"]}</code></li></ul></li><li><strong>EnableIPv6</strong> - Enable IPv6 on the network</li><li><strong>Options</strong> - Network specific options to be used by the drivers</li><li><strong>Labels</strong> - Labels to set on the network, specified as a map: <code>{"key":"value" [,"key2":"value2"]}</code></li></ul><h4 class=scroll-mt-20 id=connect-a-container-to-a-network><a class="text-black dark:text-white no-underline hover:underline" href="index.html#connect-a-container-to-a-network">Connect a container to a network</a></h4><p><code>POST /networks/(id or name)/connect</code></p><p>Connect a container to a network</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'UE9TVCAvdjEuMjQvbmV0d29ya3MvMjJiZTkzZDViYWJiMDg5YzVhYWI4ZGJjMzY5MDQyZmFkNDhmZjc5MTU4NGNhMmRhMjEwMGRiODM3YTFjN2MzMC9jb25uZWN0IEhUVFAvMS4xCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpDb250ZW50LUxlbmd0aDogMTIzNDUKCnsKICAiQ29udGFpbmVyIjoiMzYxM2Y3M2JhMGU0IiwKICAiRW5kcG9pbnRDb25maWciOiB7CiAgICAiSVBBTUNvbmZpZyI6IHsKICAgICAgICAiSVB2NEFkZHJlc3MiOiIxNzIuMjQuNTYuODkiLAogICAgICAgICJJUHY2QWRkcmVzcyI6IjIwMDE6ZGI4Ojo1Njg5IgogICAgfQogIH0KfQ==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>POST /v1.24/networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/connect HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &#34;Container&#34;:&#34;3613f73ba0e4&#34;,
  &#34;EndpointConfig&#34;: {
    &#34;IPAMConfig&#34;: {
        &#34;IPv4Address&#34;:&#34;172.24.56.89&#34;,
        &#34;IPv6Address&#34;:&#34;2001:db8::5689&#34;
    }
  }
}</code></pre></div></div><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>403</strong> - operation not supported for swarm scoped networks</li><li><strong>404</strong> - network or container is not found</li><li><strong>500</strong> - Internal Server Error</li></ul><p><strong>JSON parameters</strong>:</p><ul><li><strong>container</strong> - container-id/name to be connected to the network</li></ul><h4 class=scroll-mt-20 id=disconnect-a-container-from-a-network><a class="text-black dark:text-white no-underline hover:underline" href="index.html#disconnect-a-container-from-a-network">Disconnect a container from a network</a></h4><p><code>POST /networks/(id or name)/disconnect</code></p><p>Disconnect a container from a network</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'UE9TVCAvdjEuMjQvbmV0d29ya3MvMjJiZTkzZDViYWJiMDg5YzVhYWI4ZGJjMzY5MDQyZmFkNDhmZjc5MTU4NGNhMmRhMjEwMGRiODM3YTFjN2MzMC9kaXNjb25uZWN0IEhUVFAvMS4xCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpDb250ZW50LUxlbmd0aDogMTIzNDUKCnsKICAiQ29udGFpbmVyIjoiMzYxM2Y3M2JhMGU0IiwKICAiRm9yY2UiOmZhbHNlCn0=', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>POST /v1.24/networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30/disconnect HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &#34;Container&#34;:&#34;3613f73ba0e4&#34;,
  &#34;Force&#34;:false
}</code></pre></div></div><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>403</strong> - operation not supported for swarm scoped networks</li><li><strong>404</strong> - network or container not found</li><li><strong>500</strong> - Internal Server Error</li></ul><p><strong>JSON parameters</strong>:</p><ul><li><strong>Container</strong> - container-id/name to be disconnected from a network</li><li><strong>Force</strong> - Force the container to disconnect from a network</li></ul><h4 class=scroll-mt-20 id=remove-a-network><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-a-network">Remove a network</a></h4><p><code>DELETE /networks/(id or name)</code></p><p>Instruct the driver to remove the network (<code>id</code>).</p><p><strong>Example request</strong>:</p><pre><code>DELETE /v1.24/networks/22be93d5babb089c5aab8dbc369042fad48ff791584ca2da2100db837a1c7c30 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 204 No Content
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>204</strong> - no error</li><li><strong>403</strong> - operation not supported for pre-defined networks</li><li><strong>404</strong> - no such network</li><li><strong>500</strong> - server error</li></ul><h3 class=scroll-mt-20 id=36-plugins-experimental><a class="text-black dark:text-white no-underline hover:underline" href="index.html#36-plugins-experimental">3.6 Plugins (experimental)</a></h3><h4 class=scroll-mt-20 id=list-plugins><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-plugins">List plugins</a></h4><p><code>GET /plugins</code></p><p>Returns information about installed plugins.</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/plugins HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgoKWwogIHsKICAgICJJZCI6ICI1NzI0ZTJjODY1MmRhMzM3YWIyZWVkZDE5ZmM2ZmMwZWM5MDhlNGJkOTA3Yzc0MjFiZjZhOGRmYzcwYzRjMDc4IiwKICAgICJOYW1lIjogInRpYm9ydmFzcy9uby1yZW1vdmUiLAogICAgIlRhZyI6ICJsYXRlc3QiLAogICAgIkFjdGl2ZSI6IHRydWUsCiAgICAiQ29uZmlnIjogewogICAgICAiTW91bnRzIjogWwogICAgICAgIHsKICAgICAgICAgICJOYW1lIjogIiIsCiAgICAgICAgICAiRGVzY3JpcHRpb24iOiAiIiwKICAgICAgICAgICJTZXR0YWJsZSI6IG51bGwsCiAgICAgICAgICAiU291cmNlIjogIi9kYXRhIiwKICAgICAgICAgICJEZXN0aW5hdGlvbiI6ICIvZGF0YSIsCiAgICAgICAgICAiVHlwZSI6ICJiaW5kIiwKICAgICAgICAgICJPcHRpb25zIjogWwogICAgICAgICAgICAic2hhcmVkIiwKICAgICAgICAgICAgInJiaW5kIgogICAgICAgICAgXQogICAgICAgIH0sCiAgICAgICAgewogICAgICAgICAgIk5hbWUiOiAiIiwKICAgICAgICAgICJEZXNjcmlwdGlvbiI6ICIiLAogICAgICAgICAgIlNldHRhYmxlIjogbnVsbCwKICAgICAgICAgICJTb3VyY2UiOiBudWxsLAogICAgICAgICAgIkRlc3RpbmF0aW9uIjogIi9mb29iYXIiLAogICAgICAgICAgIlR5cGUiOiAidG1wZnMiLAogICAgICAgICAgIk9wdGlvbnMiOiBudWxsCiAgICAgICAgfQogICAgICBdLAogICAgICAiRW52IjogWwogICAgICAgICJERUJVRz0xIgogICAgICBdLAogICAgICAiQXJncyI6IG51bGwsCiAgICAgICJEZXZpY2VzIjogbnVsbAogICAgfSwKICAgICJNYW5pZmVzdCI6IHsKICAgICAgIk1hbmlmZXN0VmVyc2lvbiI6ICJ2MCIsCiAgICAgICJEZXNjcmlwdGlvbiI6ICJBIHRlc3QgcGx1Z2luIGZvciBEb2NrZXIiLAogICAgICAiRG9jdW1lbnRhdGlvbiI6ICJodHRwczovL2RvY3MuZG9ja2VyLmNvbS9lbmdpbmUvZXh0ZW5kL3BsdWdpbnMvIiwKICAgICAgIkludGVyZmFjZSI6IHsKICAgICAgICAiVHlwZXMiOiBbCiAgICAgICAgICAiZG9ja2VyLnZvbHVtZWRyaXZlci8xLjAiCiAgICAgICAgXSwKICAgICAgICAiU29ja2V0IjogInBsdWdpbnMuc29jayIKICAgICAgfSwKICAgICAgIkVudHJ5cG9pbnQiOiBbCiAgICAgICAgInBsdWdpbi1uby1yZW1vdmUiLAogICAgICAgICIvZGF0YSIKICAgICAgXSwKICAgICAgIldvcmtkaXIiOiAiIiwKICAgICAgIlVzZXIiOiB7CiAgICAgIH0sCiAgICAgICJOZXR3b3JrIjogewogICAgICAgICJUeXBlIjogImhvc3QiCiAgICAgIH0sCiAgICAgICJDYXBhYmlsaXRpZXMiOiBudWxsLAogICAgICAiTW91bnRzIjogWwogICAgICAgIHsKICAgICAgICAgICJOYW1lIjogIiIsCiAgICAgICAgICAiRGVzY3JpcHRpb24iOiAiIiwKICAgICAgICAgICJTZXR0YWJsZSI6IG51bGwsCiAgICAgICAgICAiU291cmNlIjogIi9kYXRhIiwKICAgICAgICAgICJEZXN0aW5hdGlvbiI6ICIvZGF0YSIsCiAgICAgICAgICAiVHlwZSI6ICJiaW5kIiwKICAgICAgICAgICJPcHRpb25zIjogWwogICAgICAgICAgICAic2hhcmVkIiwKICAgICAgICAgICAgInJiaW5kIgogICAgICAgICAgXQogICAgICAgIH0sCiAgICAgICAgewogICAgICAgICAgIk5hbWUiOiAiIiwKICAgICAgICAgICJEZXNjcmlwdGlvbiI6ICIiLAogICAgICAgICAgIlNldHRhYmxlIjogbnVsbCwKICAgICAgICAgICJTb3VyY2UiOiBudWxsLAogICAgICAgICAgIkRlc3RpbmF0aW9uIjogIi9mb29iYXIiLAogICAgICAgICAgIlR5cGUiOiAidG1wZnMiLAogICAgICAgICAgIk9wdGlvbnMiOiBudWxsCiAgICAgICAgfQogICAgICBdLAogICAgICAiRGV2aWNlcyI6IFsKICAgICAgICB7CiAgICAgICAgICAiTmFtZSI6ICJkZXZpY2UiLAogICAgICAgICAgIkRlc2NyaXB0aW9uIjogImEgaG9zdCBkZXZpY2UgdG8gbW91bnQiLAogICAgICAgICAgIlNldHRhYmxlIjogbnVsbCwKICAgICAgICAgICJQYXRoIjogIi9kZXYvY3B1X2RtYV9sYXRlbmN5IgogICAgICAgIH0KICAgICAgXSwKICAgICAgIkVudiI6IFsKICAgICAgICB7CiAgICAgICAgICAiTmFtZSI6ICJERUJVRyIsCiAgICAgICAgICAiRGVzY3JpcHRpb24iOiAiSWYgc2V0LCBwcmludHMgZGVidWcgbWVzc2FnZXMiLAogICAgICAgICAgIlNldHRhYmxlIjogbnVsbCwKICAgICAgICAgICJWYWx1ZSI6ICIxIgogICAgICAgIH0KICAgICAgXSwKICAgICAgIkFyZ3MiOiB7CiAgICAgICAgIk5hbWUiOiAiYXJncyIsCiAgICAgICAgIkRlc2NyaXB0aW9uIjogImNvbW1hbmQgbGluZSBhcmd1bWVudHMiLAogICAgICAgICJTZXR0YWJsZSI6IG51bGwsCiAgICAgICAgIlZhbHVlIjogWwoKICAgICAgICBdCiAgICAgIH0KICAgIH0KICB9Cl0=', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    &#34;Id&#34;: &#34;5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078&#34;,
    &#34;Name&#34;: &#34;tiborvass/no-remove&#34;,
    &#34;Tag&#34;: &#34;latest&#34;,
    &#34;Active&#34;: true,
    &#34;Config&#34;: {
      &#34;Mounts&#34;: [
        {
          &#34;Name&#34;: &#34;&#34;,
          &#34;Description&#34;: &#34;&#34;,
          &#34;Settable&#34;: null,
          &#34;Source&#34;: &#34;/data&#34;,
          &#34;Destination&#34;: &#34;/data&#34;,
          &#34;Type&#34;: &#34;bind&#34;,
          &#34;Options&#34;: [
            &#34;shared&#34;,
            &#34;rbind&#34;
          ]
        },
        {
          &#34;Name&#34;: &#34;&#34;,
          &#34;Description&#34;: &#34;&#34;,
          &#34;Settable&#34;: null,
          &#34;Source&#34;: null,
          &#34;Destination&#34;: &#34;/foobar&#34;,
          &#34;Type&#34;: &#34;tmpfs&#34;,
          &#34;Options&#34;: null
        }
      ],
      &#34;Env&#34;: [
        &#34;DEBUG=1&#34;
      ],
      &#34;Args&#34;: null,
      &#34;Devices&#34;: null
    },
    &#34;Manifest&#34;: {
      &#34;ManifestVersion&#34;: &#34;v0&#34;,
      &#34;Description&#34;: &#34;A test plugin for Docker&#34;,
      &#34;Documentation&#34;: &#34;https://docs.docker.com/engine/extend/plugins/&#34;,
      &#34;Interface&#34;: {
        &#34;Types&#34;: [
          &#34;docker.volumedriver/1.0&#34;
        ],
        &#34;Socket&#34;: &#34;plugins.sock&#34;
      },
      &#34;Entrypoint&#34;: [
        &#34;plugin-no-remove&#34;,
        &#34;/data&#34;
      ],
      &#34;Workdir&#34;: &#34;&#34;,
      &#34;User&#34;: {
      },
      &#34;Network&#34;: {
        &#34;Type&#34;: &#34;host&#34;
      },
      &#34;Capabilities&#34;: null,
      &#34;Mounts&#34;: [
        {
          &#34;Name&#34;: &#34;&#34;,
          &#34;Description&#34;: &#34;&#34;,
          &#34;Settable&#34;: null,
          &#34;Source&#34;: &#34;/data&#34;,
          &#34;Destination&#34;: &#34;/data&#34;,
          &#34;Type&#34;: &#34;bind&#34;,
          &#34;Options&#34;: [
            &#34;shared&#34;,
            &#34;rbind&#34;
          ]
        },
        {
          &#34;Name&#34;: &#34;&#34;,
          &#34;Description&#34;: &#34;&#34;,
          &#34;Settable&#34;: null,
          &#34;Source&#34;: null,
          &#34;Destination&#34;: &#34;/foobar&#34;,
          &#34;Type&#34;: &#34;tmpfs&#34;,
          &#34;Options&#34;: null
        }
      ],
      &#34;Devices&#34;: [
        {
          &#34;Name&#34;: &#34;device&#34;,
          &#34;Description&#34;: &#34;a host device to mount&#34;,
          &#34;Settable&#34;: null,
          &#34;Path&#34;: &#34;/dev/cpu_dma_latency&#34;
        }
      ],
      &#34;Env&#34;: [
        {
          &#34;Name&#34;: &#34;DEBUG&#34;,
          &#34;Description&#34;: &#34;If set, prints debug messages&#34;,
          &#34;Settable&#34;: null,
          &#34;Value&#34;: &#34;1&#34;
        }
      ],
      &#34;Args&#34;: {
        &#34;Name&#34;: &#34;args&#34;,
        &#34;Description&#34;: &#34;command line arguments&#34;,
        &#34;Settable&#34;: null,
        &#34;Value&#34;: [

        ]
      }
    }
  }
]</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=install-a-plugin><a class="text-black dark:text-white no-underline hover:underline" href="index.html#install-a-plugin">Install a plugin</a></h4><p><code>POST /plugins/pull?name=&lt;plugin name></code></p><p>Pulls and installs a plugin. After the plugin is installed, it can be enabled
using the
<a class=link href="index.html#enable-a-plugin"><code>POST /plugins/(plugin name)/enable</code> endpoint</a>.</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'UE9TVCAvdjEuMjQvcGx1Z2lucy9wdWxsP25hbWU9dGlib3J2YXNzL25vLXJlbW92ZTpsYXRlc3QgSFRUUC8xLjE=', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>POST /v1.24/plugins/pull?name=tiborvass/no-remove:latest HTTP/1.1</code></pre></div></div><p>The <code>:latest</code> tag is optional, and is used as default if omitted. When using
this endpoint to pull a plugin from the registry, the <code>X-Registry-Auth</code> header
can be used to include a base64-encoded AuthConfig object. Refer to the
<a class=link href="index.html#create-an-image">create
an image</a> section for more details.</p><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpDb250ZW50LUxlbmd0aDogMTc1CgpbCiAgewogICAgIk5hbWUiOiAibmV0d29yayIsCiAgICAiRGVzY3JpcHRpb24iOiAiIiwKICAgICJWYWx1ZSI6IFsKICAgICAgImhvc3QiCiAgICBdCiAgfSwKICB7CiAgICAiTmFtZSI6ICJtb3VudCIsCiAgICAiRGVzY3JpcHRpb24iOiAiIiwKICAgICJWYWx1ZSI6IFsKICAgICAgIi9kYXRhIgogICAgXQogIH0sCiAgewogICAgIk5hbWUiOiAiZGV2aWNlIiwKICAgICJEZXNjcmlwdGlvbiI6ICIiLAogICAgIlZhbHVlIjogWwogICAgICAiL2Rldi9jcHVfZG1hX2xhdGVuY3kiCiAgICBdCiAgfQpd', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 175

[
  {
    &#34;Name&#34;: &#34;network&#34;,
    &#34;Description&#34;: &#34;&#34;,
    &#34;Value&#34;: [
      &#34;host&#34;
    ]
  },
  {
    &#34;Name&#34;: &#34;mount&#34;,
    &#34;Description&#34;: &#34;&#34;,
    &#34;Value&#34;: [
      &#34;/data&#34;
    ]
  },
  {
    &#34;Name&#34;: &#34;device&#34;,
    &#34;Description&#34;: &#34;&#34;,
    &#34;Value&#34;: [
      &#34;/dev/cpu_dma_latency&#34;
    ]
  }
]</code></pre></div></div><p><strong>Query parameters</strong>:</p><ul><li><strong>name</strong> - Name of the plugin to pull. The name may include a tag or digest.
This parameter is required.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>500</strong> - error parsing reference / not a valid repository/tag: repository
name must have at least one component</li><li><strong>500</strong> - plugin already exists</li></ul><h4 class=scroll-mt-20 id=inspect-a-plugin><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-a-plugin">Inspect a plugin</a></h4><p><code>GET /plugins/(plugin name)</code></p><p>Returns detailed information about an installed plugin.</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'R0VUIC92MS4yNC9wbHVnaW5zL3RpYm9ydmFzcy9uby1yZW1vdmU6bGF0ZXN0IEhUVFAvMS4x', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>GET /v1.24/plugins/tiborvass/no-remove:latest HTTP/1.1</code></pre></div></div><p>The <code>:latest</code> tag is optional, and is used as default if omitted.</p><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgoKewogICJJZCI6ICI1NzI0ZTJjODY1MmRhMzM3YWIyZWVkZDE5ZmM2ZmMwZWM5MDhlNGJkOTA3Yzc0MjFiZjZhOGRmYzcwYzRjMDc4IiwKICAiTmFtZSI6ICJ0aWJvcnZhc3Mvbm8tcmVtb3ZlIiwKICAiVGFnIjogImxhdGVzdCIsCiAgIkFjdGl2ZSI6IGZhbHNlLAogICJDb25maWciOiB7CiAgICAiTW91bnRzIjogWwogICAgICB7CiAgICAgICAgIk5hbWUiOiAiIiwKICAgICAgICAiRGVzY3JpcHRpb24iOiAiIiwKICAgICAgICAiU2V0dGFibGUiOiBudWxsLAogICAgICAgICJTb3VyY2UiOiAiL2RhdGEiLAogICAgICAgICJEZXN0aW5hdGlvbiI6ICIvZGF0YSIsCiAgICAgICAgIlR5cGUiOiAiYmluZCIsCiAgICAgICAgIk9wdGlvbnMiOiBbCiAgICAgICAgICAic2hhcmVkIiwKICAgICAgICAgICJyYmluZCIKICAgICAgICBdCiAgICAgIH0sCiAgICAgIHsKICAgICAgICAiTmFtZSI6ICIiLAogICAgICAgICJEZXNjcmlwdGlvbiI6ICIiLAogICAgICAgICJTZXR0YWJsZSI6IG51bGwsCiAgICAgICAgIlNvdXJjZSI6IG51bGwsCiAgICAgICAgIkRlc3RpbmF0aW9uIjogIi9mb29iYXIiLAogICAgICAgICJUeXBlIjogInRtcGZzIiwKICAgICAgICAiT3B0aW9ucyI6IG51bGwKICAgICAgfQogICAgXSwKICAgICJFbnYiOiBbCiAgICAgICJERUJVRz0xIgogICAgXSwKICAgICJBcmdzIjogbnVsbCwKICAgICJEZXZpY2VzIjogbnVsbAogIH0sCiAgIk1hbmlmZXN0IjogewogICAgIk1hbmlmZXN0VmVyc2lvbiI6ICJ2MCIsCiAgICAiRGVzY3JpcHRpb24iOiAiQSB0ZXN0IHBsdWdpbiBmb3IgRG9ja2VyIiwKICAgICJEb2N1bWVudGF0aW9uIjogImh0dHBzOi8vZG9jcy5kb2NrZXIuY29tL2VuZ2luZS9leHRlbmQvcGx1Z2lucy8iLAogICAgIkludGVyZmFjZSI6IHsKICAgICAgIlR5cGVzIjogWwogICAgICAgICJkb2NrZXIudm9sdW1lZHJpdmVyLzEuMCIKICAgICAgXSwKICAgICAgIlNvY2tldCI6ICJwbHVnaW5zLnNvY2siCiAgICB9LAogICAgIkVudHJ5cG9pbnQiOiBbCiAgICAgICJwbHVnaW4tbm8tcmVtb3ZlIiwKICAgICAgIi9kYXRhIgogICAgXSwKICAgICJXb3JrZGlyIjogIiIsCiAgICAiVXNlciI6IHsKICAgIH0sCiAgICAiTmV0d29yayI6IHsKICAgICAgIlR5cGUiOiAiaG9zdCIKICAgIH0sCiAgICAiQ2FwYWJpbGl0aWVzIjogbnVsbCwKICAgICJNb3VudHMiOiBbCiAgICAgIHsKICAgICAgICAiTmFtZSI6ICIiLAogICAgICAgICJEZXNjcmlwdGlvbiI6ICIiLAogICAgICAgICJTZXR0YWJsZSI6IG51bGwsCiAgICAgICAgIlNvdXJjZSI6ICIvZGF0YSIsCiAgICAgICAgIkRlc3RpbmF0aW9uIjogIi9kYXRhIiwKICAgICAgICAiVHlwZSI6ICJiaW5kIiwKICAgICAgICAiT3B0aW9ucyI6IFsKICAgICAgICAgICJzaGFyZWQiLAogICAgICAgICAgInJiaW5kIgogICAgICAgIF0KICAgICAgfSwKICAgICAgewogICAgICAgICJOYW1lIjogIiIsCiAgICAgICAgIkRlc2NyaXB0aW9uIjogIiIsCiAgICAgICAgIlNldHRhYmxlIjogbnVsbCwKICAgICAgICAiU291cmNlIjogbnVsbCwKICAgICAgICAiRGVzdGluYXRpb24iOiAiL2Zvb2JhciIsCiAgICAgICAgIlR5cGUiOiAidG1wZnMiLAogICAgICAgICJPcHRpb25zIjogbnVsbAogICAgICB9CiAgICBdLAogICAgIkRldmljZXMiOiBbCiAgICAgIHsKICAgICAgICAiTmFtZSI6ICJkZXZpY2UiLAogICAgICAgICJEZXNjcmlwdGlvbiI6ICJhIGhvc3QgZGV2aWNlIHRvIG1vdW50IiwKICAgICAgICAiU2V0dGFibGUiOiBudWxsLAogICAgICAgICJQYXRoIjogIi9kZXYvY3B1X2RtYV9sYXRlbmN5IgogICAgICB9CiAgICBdLAogICAgIkVudiI6IFsKICAgICAgewogICAgICAgICJOYW1lIjogIkRFQlVHIiwKICAgICAgICAiRGVzY3JpcHRpb24iOiAiSWYgc2V0LCBwcmludHMgZGVidWcgbWVzc2FnZXMiLAogICAgICAgICJTZXR0YWJsZSI6IG51bGwsCiAgICAgICAgIlZhbHVlIjogIjEiCiAgICAgIH0KICAgIF0sCiAgICAiQXJncyI6IHsKICAgICAgIk5hbWUiOiAiYXJncyIsCiAgICAgICJEZXNjcmlwdGlvbiI6ICJjb21tYW5kIGxpbmUgYXJndW1lbnRzIiwKICAgICAgIlNldHRhYmxlIjogbnVsbCwKICAgICAgIlZhbHVlIjogWwoKICAgICAgXQogICAgfQogIH0KfQ==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &#34;Id&#34;: &#34;5724e2c8652da337ab2eedd19fc6fc0ec908e4bd907c7421bf6a8dfc70c4c078&#34;,
  &#34;Name&#34;: &#34;tiborvass/no-remove&#34;,
  &#34;Tag&#34;: &#34;latest&#34;,
  &#34;Active&#34;: false,
  &#34;Config&#34;: {
    &#34;Mounts&#34;: [
      {
        &#34;Name&#34;: &#34;&#34;,
        &#34;Description&#34;: &#34;&#34;,
        &#34;Settable&#34;: null,
        &#34;Source&#34;: &#34;/data&#34;,
        &#34;Destination&#34;: &#34;/data&#34;,
        &#34;Type&#34;: &#34;bind&#34;,
        &#34;Options&#34;: [
          &#34;shared&#34;,
          &#34;rbind&#34;
        ]
      },
      {
        &#34;Name&#34;: &#34;&#34;,
        &#34;Description&#34;: &#34;&#34;,
        &#34;Settable&#34;: null,
        &#34;Source&#34;: null,
        &#34;Destination&#34;: &#34;/foobar&#34;,
        &#34;Type&#34;: &#34;tmpfs&#34;,
        &#34;Options&#34;: null
      }
    ],
    &#34;Env&#34;: [
      &#34;DEBUG=1&#34;
    ],
    &#34;Args&#34;: null,
    &#34;Devices&#34;: null
  },
  &#34;Manifest&#34;: {
    &#34;ManifestVersion&#34;: &#34;v0&#34;,
    &#34;Description&#34;: &#34;A test plugin for Docker&#34;,
    &#34;Documentation&#34;: &#34;https://docs.docker.com/engine/extend/plugins/&#34;,
    &#34;Interface&#34;: {
      &#34;Types&#34;: [
        &#34;docker.volumedriver/1.0&#34;
      ],
      &#34;Socket&#34;: &#34;plugins.sock&#34;
    },
    &#34;Entrypoint&#34;: [
      &#34;plugin-no-remove&#34;,
      &#34;/data&#34;
    ],
    &#34;Workdir&#34;: &#34;&#34;,
    &#34;User&#34;: {
    },
    &#34;Network&#34;: {
      &#34;Type&#34;: &#34;host&#34;
    },
    &#34;Capabilities&#34;: null,
    &#34;Mounts&#34;: [
      {
        &#34;Name&#34;: &#34;&#34;,
        &#34;Description&#34;: &#34;&#34;,
        &#34;Settable&#34;: null,
        &#34;Source&#34;: &#34;/data&#34;,
        &#34;Destination&#34;: &#34;/data&#34;,
        &#34;Type&#34;: &#34;bind&#34;,
        &#34;Options&#34;: [
          &#34;shared&#34;,
          &#34;rbind&#34;
        ]
      },
      {
        &#34;Name&#34;: &#34;&#34;,
        &#34;Description&#34;: &#34;&#34;,
        &#34;Settable&#34;: null,
        &#34;Source&#34;: null,
        &#34;Destination&#34;: &#34;/foobar&#34;,
        &#34;Type&#34;: &#34;tmpfs&#34;,
        &#34;Options&#34;: null
      }
    ],
    &#34;Devices&#34;: [
      {
        &#34;Name&#34;: &#34;device&#34;,
        &#34;Description&#34;: &#34;a host device to mount&#34;,
        &#34;Settable&#34;: null,
        &#34;Path&#34;: &#34;/dev/cpu_dma_latency&#34;
      }
    ],
    &#34;Env&#34;: [
      {
        &#34;Name&#34;: &#34;DEBUG&#34;,
        &#34;Description&#34;: &#34;If set, prints debug messages&#34;,
        &#34;Settable&#34;: null,
        &#34;Value&#34;: &#34;1&#34;
      }
    ],
    &#34;Args&#34;: {
      &#34;Name&#34;: &#34;args&#34;,
      &#34;Description&#34;: &#34;command line arguments&#34;,
      &#34;Settable&#34;: null,
      &#34;Value&#34;: [

      ]
    }
  }
}</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>404</strong> - plugin not installed</li></ul><h4 class=scroll-mt-20 id=enable-a-plugin><a class="text-black dark:text-white no-underline hover:underline" href="index.html#enable-a-plugin">Enable a plugin</a></h4><p><code>POST /plugins/(plugin name)/enable</code></p><p>Enables a plugin</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'UE9TVCAvdjEuMjQvcGx1Z2lucy90aWJvcnZhc3Mvbm8tcmVtb3ZlOmxhdGVzdC9lbmFibGUgSFRUUC8xLjE=', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>POST /v1.24/plugins/tiborvass/no-remove:latest/enable HTTP/1.1</code></pre></div></div><p>The <code>:latest</code> tag is optional, and is used as default if omitted.</p><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtTGVuZ3RoOiAwCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>404</strong> - plugin not installed</li><li><strong>500</strong> - plugin is already enabled</li></ul><h4 class=scroll-mt-20 id=disable-a-plugin><a class="text-black dark:text-white no-underline hover:underline" href="index.html#disable-a-plugin">Disable a plugin</a></h4><p><code>POST /plugins/(plugin name)/disable</code></p><p>Disables a plugin</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'UE9TVCAvdjEuMjQvcGx1Z2lucy90aWJvcnZhc3Mvbm8tcmVtb3ZlOmxhdGVzdC9kaXNhYmxlIEhUVFAvMS4x', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>POST /v1.24/plugins/tiborvass/no-remove:latest/disable HTTP/1.1</code></pre></div></div><p>The <code>:latest</code> tag is optional, and is used as default if omitted.</p><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtTGVuZ3RoOiAwCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>404</strong> - plugin not installed</li><li><strong>500</strong> - plugin is already disabled</li></ul><h4 class=scroll-mt-20 id=remove-a-plugin><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-a-plugin">Remove a plugin</a></h4><p><code>DELETE /plugins/(plugin name)</code></p><p>Removes a plugin</p><p><strong>Example request</strong>:</p><div class="group relative"><button x-data="{ code: 'REVMRVRFIC92MS4yNC9wbHVnaW5zL3RpYm9ydmFzcy9uby1yZW1vdmU6bGF0ZXN0IEhUVFAvMS4x', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>DELETE /v1.24/plugins/tiborvass/no-remove:latest HTTP/1.1</code></pre></div></div><p>The <code>:latest</code> tag is optional, and is used as default if omitted.</p><p><strong>Example response</strong>:</p><div class="group relative"><button x-data="{ code: 'SFRUUC8xLjEgMjAwIE9LCkNvbnRlbnQtTGVuZ3RoOiAwCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11dGYtOA==', copying: false }" class="absolute top-3 right-3 text-gray-light-300 dark:text-gray-dark-600" title=Copy @click="window.navigator.clipboard.writeText(atob(code).replaceAll(/^\$\s*/gm, ''));
    copying = true;
    setTimeout(() => copying = false, 2000);">
<span :class="{ 'group-hover:block' : !copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M3e2-2e2q-24 0-42-18t-18-42v-560q0-24 18-42t42-18h440q24 0 42 18t18 42v560q0 24-18 42t-42 18H3e2zM180-80q-24 0-42-18t-18-42v-590q0-13 8.5-21.5T150-760t21.5 8.5T180-730v590h470q13 0 21.5 8.5T680-110t-8.5 21.5T650-80H180z"/></svg></span>
<span :class="{ 'group-hover:block' : copying }" class="hidden icon-svg"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m421-389-98-98q-9-9-22-9t-23 10q-9 9-9 22t9 22l122 123q9 9 21 9t21-9l239-239q10-10 10-23t-10-23q-10-9-23.5-8.5T635-603L421-389zm59 309q-82 0-155-31.5t-127.5-86-86-127.5T80-480q0-83 31.5-156t86-127T325-848.5 480-880q83 0 156 31.5T763-763t85.5 127T880-480q0 82-31.5 155T763-197.5t-127 86T480-80z"/></svg></span></button><div class="syntax-light dark:syntax-dark"><pre tabindex=0><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8</code></pre></div></div><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>404</strong> - plugin not installed</li><li><strong>500</strong> - plugin is active</li></ul><h3 class=scroll-mt-20 id=37-nodes><a class="text-black dark:text-white no-underline hover:underline" href="index.html#37-nodes">3.7 Nodes</a></h3><p><strong>Note</strong>: Node operations require the engine to be part of a swarm.</p><h4 class=scroll-mt-20 id=list-nodes><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-nodes">List nodes</a></h4><p><code>GET /nodes</code></p><p>List nodes</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/nodes HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    &quot;ID&quot;: &quot;24ifsmvkjbyhk&quot;,
    &quot;Version&quot;: {
      &quot;Index&quot;: 8
    },
    &quot;CreatedAt&quot;: &quot;2016-06-07T20:31:11.853781916Z&quot;,
    &quot;UpdatedAt&quot;: &quot;2016-06-07T20:31:11.999868824Z&quot;,
    &quot;Spec&quot;: {
      &quot;Name&quot;: &quot;my-node&quot;,
      &quot;Role&quot;: &quot;manager&quot;,
      &quot;Availability&quot;: &quot;active&quot;
      &quot;Labels&quot;: {
          &quot;foo&quot;: &quot;bar&quot;
      }
    },
    &quot;Description&quot;: {
      &quot;Hostname&quot;: &quot;bf3067039e47&quot;,
      &quot;Platform&quot;: {
        &quot;Architecture&quot;: &quot;x86_64&quot;,
        &quot;OS&quot;: &quot;linux&quot;
      },
      &quot;Resources&quot;: {
        &quot;NanoCPUs&quot;: 4000000000,
        &quot;MemoryBytes&quot;: 8272408576
      },
      &quot;Engine&quot;: {
        &quot;EngineVersion&quot;: &quot;1.12.0&quot;,
        &quot;Labels&quot;: {
            &quot;foo&quot;: &quot;bar&quot;,
        }
        &quot;Plugins&quot;: [
          {
            &quot;Type&quot;: &quot;Volume&quot;,
            &quot;Name&quot;: &quot;local&quot;
          },
          {
            &quot;Type&quot;: &quot;Network&quot;,
            &quot;Name&quot;: &quot;bridge&quot;
          }
          {
            &quot;Type&quot;: &quot;Network&quot;,
            &quot;Name&quot;: &quot;null&quot;
          }
          {
            &quot;Type&quot;: &quot;Network&quot;,
            &quot;Name&quot;: &quot;overlay&quot;
          }
        ]
      }
    },
    &quot;Status&quot;: {
      &quot;State&quot;: &quot;ready&quot;
    },
    &quot;ManagerStatus&quot;: {
      &quot;Leader&quot;: true,
      &quot;Reachability&quot;: &quot;reachable&quot;,
      &quot;Addr&quot;: &quot;172.17.0.2:2377&quot;&quot;
    }
  }
]
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>filters</strong> – a JSON encoded value of the filters (a <code>map[string][]string</code>) to process on the
nodes list. Available filters:<ul><li><code>id=&lt;node id></code></li><li><code>label=&lt;engine label></code></li><li><code>membership=</code>(<code>accepted</code>|<code>pending</code>)`</li><li><code>name=&lt;node name></code></li><li><code>role=</code>(<code>manager</code>|<code>worker</code>)`</li></ul></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>406</strong> - node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=inspect-a-node><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-a-node">Inspect a node</a></h4><p><code>GET /nodes/(id or name)</code></p><p>Return low-level information on the node <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>  GET /v1.24/nodes/24ifsmvkjbyhk HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &quot;ID&quot;: &quot;24ifsmvkjbyhk&quot;,
  &quot;Version&quot;: {
    &quot;Index&quot;: 8
  },
  &quot;CreatedAt&quot;: &quot;2016-06-07T20:31:11.853781916Z&quot;,
  &quot;UpdatedAt&quot;: &quot;2016-06-07T20:31:11.999868824Z&quot;,
  &quot;Spec&quot;: {
    &quot;Name&quot;: &quot;my-node&quot;,
    &quot;Role&quot;: &quot;manager&quot;,
    &quot;Availability&quot;: &quot;active&quot;
    &quot;Labels&quot;: {
        &quot;foo&quot;: &quot;bar&quot;
    }
  },
  &quot;Description&quot;: {
    &quot;Hostname&quot;: &quot;bf3067039e47&quot;,
    &quot;Platform&quot;: {
      &quot;Architecture&quot;: &quot;x86_64&quot;,
      &quot;OS&quot;: &quot;linux&quot;
    },
    &quot;Resources&quot;: {
      &quot;NanoCPUs&quot;: 4000000000,
      &quot;MemoryBytes&quot;: 8272408576
    },
    &quot;Engine&quot;: {
      &quot;EngineVersion&quot;: &quot;1.12.0&quot;,
      &quot;Labels&quot;: {
          &quot;foo&quot;: &quot;bar&quot;,
      }
      &quot;Plugins&quot;: [
        {
          &quot;Type&quot;: &quot;Volume&quot;,
          &quot;Name&quot;: &quot;local&quot;
        },
        {
          &quot;Type&quot;: &quot;Network&quot;,
          &quot;Name&quot;: &quot;bridge&quot;
        }
        {
          &quot;Type&quot;: &quot;Network&quot;,
          &quot;Name&quot;: &quot;null&quot;
        }
        {
          &quot;Type&quot;: &quot;Network&quot;,
          &quot;Name&quot;: &quot;overlay&quot;
        }
      ]
    }
  },
  &quot;Status&quot;: {
    &quot;State&quot;: &quot;ready&quot;
  },
  &quot;ManagerStatus&quot;: {
    &quot;Leader&quot;: true,
    &quot;Reachability&quot;: &quot;reachable&quot;,
    &quot;Addr&quot;: &quot;172.17.0.2:2377&quot;&quot;
  }
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such node</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=remove-a-node><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-a-node">Remove a node</a></h4><p><code>DELETE /nodes/(id or name)</code></p><p>Remove a node from the swarm.</p><p><strong>Example request</strong>:</p><pre><code>DELETE /v1.24/nodes/24ifsmvkjbyhk HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>force</strong> - 1/True/true or 0/False/false, Force remove a node from the swarm.
Default <code>false</code>.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such node</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=update-a-node><a class="text-black dark:text-white no-underline hover:underline" href="index.html#update-a-node">Update a node</a></h4><p><code>POST /nodes/(id)/update</code></p><p>Update a node.</p><p>The payload of the <code>POST</code> request is the new <code>NodeSpec</code> and
overrides the current <code>NodeSpec</code> for the specified node.</p><p>If <code>Availability</code> or <code>Role</code> are omitted, this returns an
error. Any other field omitted resets the current value to either
an empty value or the default cluster-wide value.</p><p><strong>Example Request</strong></p><pre><code>POST /v1.24/nodes/24ifsmvkjbyhk/update?version=8 HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &quot;Availability&quot;: &quot;active&quot;,
  &quot;Name&quot;: &quot;node-name&quot;,
  &quot;Role&quot;: &quot;manager&quot;,
  &quot;Labels&quot;: {
    &quot;foo&quot;: &quot;bar&quot;
  }
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>version</strong> – The version number of the node object being updated. This is
required to avoid conflicting writes.</li></ul><p>JSON Parameters:</p><ul><li><strong>Annotations</strong> – Optional medata to associate with the node.<ul><li><strong>Name</strong> – User-defined name for the node.</li><li><strong>Labels</strong> – A map of labels to associate with the node (e.g.,
<code>{"key":"value", "key2":"value2"}</code>).</li></ul></li><li><strong>Role</strong> - Role of the node (worker|manager).</li><li><strong>Availability</strong> - Availability of the node (active|pause|drain).</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such node</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h3 class=scroll-mt-20 id=38-swarm><a class="text-black dark:text-white no-underline hover:underline" href="index.html#38-swarm">3.8 Swarm</a></h3><h4 class=scroll-mt-20 id=inspect-swarm><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-swarm">Inspect swarm</a></h4><p><code>GET /swarm</code></p><p>Inspect swarm</p><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

{
  &quot;CreatedAt&quot; : &quot;2016-08-15T16:00:20.349727406Z&quot;,
  &quot;Spec&quot; : {
    &quot;Dispatcher&quot; : {
      &quot;HeartbeatPeriod&quot; : 5000000000
    },
    &quot;Orchestration&quot; : {
     &quot;TaskHistoryRetentionLimit&quot; : 10
    },
    &quot;CAConfig&quot; : {
      &quot;NodeCertExpiry&quot; : 7776000000000000
    },
    &quot;Raft&quot; : {
      &quot;LogEntriesForSlowFollowers&quot; : 500,
      &quot;HeartbeatTick&quot; : 1,
      &quot;SnapshotInterval&quot; : 10000,
      &quot;ElectionTick&quot; : 3
    },
    &quot;TaskDefaults&quot; : {},
    &quot;Name&quot; : &quot;default&quot;
  },
 &quot;JoinTokens&quot; : {
    &quot;Worker&quot; : &quot;SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-6qmn92w6bu3jdvnglku58u11a&quot;,
    &quot;Manager&quot; : &quot;SWMTKN-1-1h8aps2yszaiqmz2l3oc5392pgk8e49qhx2aj3nyv0ui0hez2a-8llk83c4wm9lwioey2s316r9l&quot;
 },
 &quot;ID&quot; : &quot;70ilmkj2f6sp2137c753w2nmt&quot;,
 &quot;UpdatedAt&quot; : &quot;2016-08-15T16:32:09.623207604Z&quot;,
 &quot;Version&quot; : {
   &quot;Index&quot; : 51
}
</code></pre><p>}</p><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> - no error</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> - sever error</li></ul><h4 class=scroll-mt-20 id=initialize-a-new-swarm><a class="text-black dark:text-white no-underline hover:underline" href="index.html#initialize-a-new-swarm">Initialize a new swarm</a></h4><p><code>POST /swarm/init</code></p><p>Initialize a new swarm. The body of the HTTP response includes the node ID.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/swarm/init HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &quot;ListenAddr&quot;: &quot;0.0.0.0:2377&quot;,
  &quot;AdvertiseAddr&quot;: &quot;192.168.1.1:2377&quot;,
  &quot;ForceNewCluster&quot;: false,
  &quot;Spec&quot;: {
    &quot;Orchestration&quot;: {},
    &quot;Raft&quot;: {},
    &quot;Dispatcher&quot;: {},
    &quot;CAConfig&quot;: {}
  }
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 28
Content-Type: application/json
Date: Thu, 01 Sep 2016 21:49:13 GMT
Server: Docker/1.12.0 (linux)

&quot;7v2t30z9blmxuhnyo6s4cpenp&quot;
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>406</strong> – node is already part of a swarm</li><li><strong>500</strong> - server error</li></ul><p>JSON Parameters:</p><ul><li><strong>ListenAddr</strong> – Listen address used for inter-manager communication, as well as determining
the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an
address/port combination in the form <code>192.168.1.1:4567</code>, or an interface followed by a port
number, like <code>eth0:4567</code>. If the port number is omitted, the default swarm listening port is
used.</li><li><strong>AdvertiseAddr</strong> – Externally reachable address advertised to other nodes. This can either be
an address/port combination in the form <code>192.168.1.1:4567</code>, or an interface followed by a port
number, like <code>eth0:4567</code>. If the port number is omitted, the port number from the listen
address is used. If <code>AdvertiseAddr</code> is not specified, it will be automatically detected when
possible.</li><li><strong>ForceNewCluster</strong> – Force creation of a new swarm.</li><li><strong>Spec</strong> – Configuration settings for the new swarm.<ul><li><strong>Orchestration</strong> – Configuration settings for the orchestration aspects of the swarm.<ul><li><strong>TaskHistoryRetentionLimit</strong> – Maximum number of tasks history stored.</li></ul></li><li><strong>Raft</strong> – Raft related configuration.<ul><li><strong>SnapshotInterval</strong> – Number of logs entries between snapshot.</li><li><strong>KeepOldSnapshots</strong> – Number of snapshots to keep beyond the current snapshot.</li><li><strong>LogEntriesForSlowFollowers</strong> – Number of log entries to keep around to sync up slow
followers after a snapshot is created.</li><li><strong>HeartbeatTick</strong> – Amount of ticks (in seconds) between each heartbeat.</li><li><strong>ElectionTick</strong> – Amount of ticks (in seconds) needed without a leader to trigger a new
election.</li></ul></li><li><strong>Dispatcher</strong> – Configuration settings for the task dispatcher.<ul><li><strong>HeartbeatPeriod</strong> – The delay for an agent to send a heartbeat to the dispatcher.</li></ul></li><li><strong>CAConfig</strong> – Certificate authority configuration.<ul><li><strong>NodeCertExpiry</strong> – Automatic expiry for nodes certificates.</li><li><strong>ExternalCA</strong> - Configuration for forwarding signing requests to an external
certificate authority.<ul><li><strong>Protocol</strong> - Protocol for communication with the external CA
(currently only "cfssl" is supported).</li><li><strong>URL</strong> - URL where certificate signing requests should be sent.</li><li><strong>Options</strong> - An object with key/value pairs that are interpreted
as protocol-specific options for the external CA driver.</li></ul></li></ul></li></ul></li></ul><h4 class=scroll-mt-20 id=join-an-existing-swarm><a class="text-black dark:text-white no-underline hover:underline" href="index.html#join-an-existing-swarm">Join an existing swarm</a></h4><p><code>POST /swarm/join</code></p><p>Join an existing swarm</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/swarm/join HTTP/1.1
Content-Type: application/json

{
  &quot;ListenAddr&quot;: &quot;0.0.0.0:2377&quot;,
  &quot;AdvertiseAddr&quot;: &quot;192.168.1.1:2377&quot;,
  &quot;RemoteAddrs&quot;: [&quot;node1:2377&quot;],
  &quot;JoinToken&quot;: &quot;SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2&quot;
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>406</strong> – node is already part of a swarm</li><li><strong>500</strong> - server error</li></ul><p>JSON Parameters:</p><ul><li><strong>ListenAddr</strong> – Listen address used for inter-manager communication if the node gets promoted to
manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP).</li><li><strong>AdvertiseAddr</strong> – Externally reachable address advertised to other nodes. This can either be
an address/port combination in the form <code>192.168.1.1:4567</code>, or an interface followed by a port
number, like <code>eth0:4567</code>. If the port number is omitted, the port number from the listen
address is used. If <code>AdvertiseAddr</code> is not specified, it will be automatically detected when
possible.</li><li><strong>RemoteAddr</strong> – Address of any manager node already participating in the swarm.</li><li><strong>JoinToken</strong> – Secret token for joining this swarm.</li></ul><h4 class=scroll-mt-20 id=leave-a-swarm><a class="text-black dark:text-white no-underline hover:underline" href="index.html#leave-a-swarm">Leave a swarm</a></h4><p><code>POST /swarm/leave</code></p><p>Leave a swarm</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/swarm/leave HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>force</strong> - Boolean (0/1, false/true). Force leave swarm, even if this is the last manager or that it will break the cluster.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> - server error</li></ul><h4 class=scroll-mt-20 id=update-a-swarm><a class="text-black dark:text-white no-underline hover:underline" href="index.html#update-a-swarm">Update a swarm</a></h4><p><code>POST /swarm/update</code></p><p>Update a swarm</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/swarm/update HTTP/1.1
Content-Length: 12345

{
  &quot;Name&quot;: &quot;default&quot;,
  &quot;Orchestration&quot;: {
    &quot;TaskHistoryRetentionLimit&quot;: 10
  },
  &quot;Raft&quot;: {
    &quot;SnapshotInterval&quot;: 10000,
    &quot;LogEntriesForSlowFollowers&quot;: 500,
    &quot;HeartbeatTick&quot;: 1,
    &quot;ElectionTick&quot;: 3
  },
  &quot;Dispatcher&quot;: {
    &quot;HeartbeatPeriod&quot;: 5000000000
  },
  &quot;CAConfig&quot;: {
    &quot;NodeCertExpiry&quot;: 7776000000000000
  },
  &quot;JoinTokens&quot;: {
    &quot;Worker&quot;: &quot;SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx&quot;,
    &quot;Manager&quot;: &quot;SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2&quot;
  }
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>version</strong> – The version number of the swarm object being updated. This is
required to avoid conflicting writes.</li><li><strong>rotateWorkerToken</strong> - Set to <code>true</code> (or <code>1</code>) to rotate the worker join token.</li><li><strong>rotateManagerToken</strong> - Set to <code>true</code> (or <code>1</code>) to rotate the manager join token.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>400</strong> – bad parameter</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> - server error</li></ul><p>JSON Parameters:</p><ul><li><strong>Orchestration</strong> – Configuration settings for the orchestration aspects of the swarm.<ul><li><strong>TaskHistoryRetentionLimit</strong> – Maximum number of tasks history stored.</li></ul></li><li><strong>Raft</strong> – Raft related configuration.<ul><li><strong>SnapshotInterval</strong> – Number of logs entries between snapshot.</li><li><strong>KeepOldSnapshots</strong> – Number of snapshots to keep beyond the current snapshot.</li><li><strong>LogEntriesForSlowFollowers</strong> – Number of log entries to keep around to sync up slow
followers after a snapshot is created.</li><li><strong>HeartbeatTick</strong> – Amount of ticks (in seconds) between each heartbeat.</li><li><strong>ElectionTick</strong> – Amount of ticks (in seconds) needed without a leader to trigger a new
election.</li></ul></li><li><strong>Dispatcher</strong> – Configuration settings for the task dispatcher.<ul><li><strong>HeartbeatPeriod</strong> – The delay for an agent to send a heartbeat to the dispatcher.</li></ul></li><li><strong>CAConfig</strong> – CA configuration.<ul><li><strong>NodeCertExpiry</strong> – Automatic expiry for nodes certificates.</li><li><strong>ExternalCA</strong> - Configuration for forwarding signing requests to an external
certificate authority.<ul><li><strong>Protocol</strong> - Protocol for communication with the external CA
(currently only "cfssl" is supported).</li><li><strong>URL</strong> - URL where certificate signing requests should be sent.</li><li><strong>Options</strong> - An object with key/value pairs that are interpreted
as protocol-specific options for the external CA driver.</li></ul></li></ul></li><li><strong>JoinTokens</strong> - Tokens that can be used by other nodes to join the swarm.<ul><li><strong>Worker</strong> - Token to use for joining as a worker.</li><li><strong>Manager</strong> - Token to use for joining as a manager.</li></ul></li></ul><h3 class=scroll-mt-20 id=39-services><a class="text-black dark:text-white no-underline hover:underline" href="index.html#39-services">3.9 Services</a></h3><p><strong>Note</strong>: Service operations require to first be part of a swarm.</p><h4 class=scroll-mt-20 id=list-services><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-services">List services</a></h4><p><code>GET /services</code></p><p>List services</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/services HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    &quot;ID&quot;: &quot;9mnpnzenvg8p8tdbtq4wvbkcz&quot;,
    &quot;Version&quot;: {
      &quot;Index&quot;: 19
    },
    &quot;CreatedAt&quot;: &quot;2016-06-07T21:05:51.880065305Z&quot;,
    &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:29.962229872Z&quot;,
    &quot;Spec&quot;: {
      &quot;Name&quot;: &quot;hopeful_cori&quot;,
      &quot;TaskTemplate&quot;: {
        &quot;ContainerSpec&quot;: {
          &quot;Image&quot;: &quot;redis&quot;
        },
        &quot;Resources&quot;: {
          &quot;Limits&quot;: {},
          &quot;Reservations&quot;: {}
        },
        &quot;RestartPolicy&quot;: {
          &quot;Condition&quot;: &quot;any&quot;,
          &quot;MaxAttempts&quot;: 0
        },
        &quot;Placement&quot;: {
          &quot;Constraints&quot;: [
            &quot;node.role == worker&quot;
          ]
        }
      },
      &quot;Mode&quot;: {
        &quot;Replicated&quot;: {
          &quot;Replicas&quot;: 1
        }
      },
      &quot;UpdateConfig&quot;: {
        &quot;Parallelism&quot;: 1,
        &quot;FailureAction&quot;: &quot;pause&quot;
      },
      &quot;EndpointSpec&quot;: {
        &quot;Mode&quot;: &quot;vip&quot;,
        &quot;Ports&quot;: [
          {
            &quot;Protocol&quot;: &quot;tcp&quot;,
            &quot;TargetPort&quot;: 6379,
            &quot;PublishedPort&quot;: 30001
          }
        ]
      }
    },
    &quot;Endpoint&quot;: {
      &quot;Spec&quot;: {
        &quot;Mode&quot;: &quot;vip&quot;,
        &quot;Ports&quot;: [
          {
            &quot;Protocol&quot;: &quot;tcp&quot;,
            &quot;TargetPort&quot;: 6379,
            &quot;PublishedPort&quot;: 30001
          }
        ]
      },
      &quot;Ports&quot;: [
        {
          &quot;Protocol&quot;: &quot;tcp&quot;,
          &quot;TargetPort&quot;: 6379,
          &quot;PublishedPort&quot;: 30001
        }
      ],
      &quot;VirtualIPs&quot;: [
        {
          &quot;NetworkID&quot;: &quot;4qvuz4ko70xaltuqbt8956gd1&quot;,
          &quot;Addr&quot;: &quot;10.255.0.2/16&quot;
        },
        {
          &quot;NetworkID&quot;: &quot;4qvuz4ko70xaltuqbt8956gd1&quot;,
          &quot;Addr&quot;: &quot;10.255.0.3/16&quot;
        }
      ]
    }
  }
]
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>filters</strong> – a JSON encoded value of the filters (a <code>map[string][]string</code>) to process on the
services list. Available filters:<ul><li><code>id=&lt;service id></code></li><li><code>label=&lt;service label></code></li><li><code>name=&lt;service name></code></li></ul></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=create-a-service><a class="text-black dark:text-white no-underline hover:underline" href="index.html#create-a-service">Create a service</a></h4><p><code>POST /services/create</code></p><p>Create a service. When using this endpoint to create a service using a private
repository from the registry, the <code>X-Registry-Auth</code> header must be used to
include a base64-encoded AuthConfig object. Refer to the
<a class=link href="index.html#create-an-image">create an
image</a> section for more details.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/services/create HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &quot;Name&quot;: &quot;web&quot;,
  &quot;TaskTemplate&quot;: {
    &quot;ContainerSpec&quot;: {
      &quot;Image&quot;: &quot;nginx:alpine&quot;,
      &quot;Mounts&quot;: [
        {
          &quot;ReadOnly&quot;: true,
          &quot;Source&quot;: &quot;web-data&quot;,
          &quot;Target&quot;: &quot;/usr/share/nginx/html&quot;,
          &quot;Type&quot;: &quot;volume&quot;,
          &quot;VolumeOptions&quot;: {
            &quot;DriverConfig&quot;: {
            },
            &quot;Labels&quot;: {
              &quot;com.example.something&quot;: &quot;something-value&quot;
            }
          }
        }
      ],
      &quot;User&quot;: &quot;33&quot;
    },
    &quot;Networks&quot;: [
        {
          &quot;Target&quot;: &quot;overlay1&quot;
        }
    ],
    &quot;LogDriver&quot;: {
      &quot;Name&quot;: &quot;json-file&quot;,
      &quot;Options&quot;: {
        &quot;max-file&quot;: &quot;3&quot;,
        &quot;max-size&quot;: &quot;10M&quot;
      }
    },
    &quot;Placement&quot;: {
      &quot;Constraints&quot;: [
        &quot;node.role == worker&quot;
      ]
    },
    &quot;Resources&quot;: {
      &quot;Limits&quot;: {
        &quot;MemoryBytes&quot;: 104857600
      },
      &quot;Reservations&quot;: {
      }
    },
    &quot;RestartPolicy&quot;: {
      &quot;Condition&quot;: &quot;on-failure&quot;,
      &quot;Delay&quot;: 10000000000,
      &quot;MaxAttempts&quot;: 10
    }
  },
  &quot;Mode&quot;: {
    &quot;Replicated&quot;: {
      &quot;Replicas&quot;: 4
    }
  },
  &quot;UpdateConfig&quot;: {
    &quot;Delay&quot;: 30000000000,
    &quot;Parallelism&quot;: 2,
    &quot;FailureAction&quot;: &quot;pause&quot;
  },
  &quot;EndpointSpec&quot;: {
    &quot;Ports&quot;: [
      {
        &quot;Protocol&quot;: &quot;tcp&quot;,
        &quot;PublishedPort&quot;: 8080,
        &quot;TargetPort&quot;: 80
      }
    ]
  },
  &quot;Labels&quot;: {
    &quot;foo&quot;: &quot;bar&quot;
  }
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 201 Created
Content-Type: application/json

{
  &quot;ID&quot;:&quot;ak7w3gjqoa3kuz8xcpnyy0pvl&quot;
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>201</strong> – no error</li><li><strong>403</strong> - network is not eligible for services</li><li><strong>406</strong> – node is not part of a swarm</li><li><strong>409</strong> – name conflicts with an existing object</li><li><strong>500</strong> - server error</li></ul><p><strong>JSON Parameters</strong>:</p><ul><li><strong>Name</strong> – User-defined name for the service.</li><li><strong>Labels</strong> – A map of labels to associate with the service (e.g., <code>{"key":"value", "key2":"value2"}</code>).</li><li><strong>TaskTemplate</strong> – Specification of the tasks to start as part of the new service.<ul><li><strong>ContainerSpec</strong> - Container settings for containers started as part of this task.<ul><li><strong>Image</strong> – A string specifying the image name to use for the container.</li><li><strong>Command</strong> – The command to be run in the image.</li><li><strong>Args</strong> – Arguments to the command.</li><li><strong>Env</strong> – A list of environment variables in the form of <code>["VAR=value"[,"VAR2=value2"]]</code>.</li><li><strong>Dir</strong> – A string specifying the working directory for commands to run in.</li><li><strong>User</strong> – A string value specifying the user inside the container.</li><li><strong>Labels</strong> – A map of labels to associate with the service (e.g.,
<code>{"key":"value", "key2":"value2"}</code>).</li><li><strong>Mounts</strong> – Specification for mounts to be added to containers
created as part of the service.<ul><li><strong>Target</strong> – Container path.</li><li><strong>Source</strong> – Mount source (e.g. a volume name, a host path).</li><li><strong>Type</strong> – The mount type (<code>bind</code>, or <code>volume</code>).</li><li><strong>ReadOnly</strong> – A boolean indicating whether the mount should be read-only.</li><li><strong>BindOptions</strong> - Optional configuration for the <code>bind</code> type.<ul><li><strong>Propagation</strong> – A propagation mode with the value <code>[r]private</code>, <code>[r]shared</code>, or <code>[r]slave</code>.</li></ul></li><li><strong>VolumeOptions</strong> – Optional configuration for the <code>volume</code> type.<ul><li><strong>NoCopy</strong> – A boolean indicating if volume should be
populated with the data from the target. (Default false)</li><li><strong>Labels</strong> – User-defined name and labels for the volume.</li><li><strong>DriverConfig</strong> – Map of driver-specific options.<ul><li><strong>Name</strong> - Name of the driver to use to create the volume.</li><li><strong>Options</strong> - key/value map of driver specific options.</li></ul></li></ul></li></ul></li><li><strong>StopGracePeriod</strong> – Amount of time to wait for the container to terminate before
forcefully killing it.</li></ul></li><li><strong>LogDriver</strong> - Log configuration for containers created as part of the
service.<ul><li><strong>Name</strong> - Name of the logging driver to use (<code>json-file</code>, <code>syslog</code>,
<code>journald</code>, <code>gelf</code>, <code>fluentd</code>, <code>awslogs</code>, <code>splunk</code>, <code>etwlogs</code>, <code>none</code>).</li><li><strong>Options</strong> - Driver-specific options.</li></ul></li><li><strong>Resources</strong> – Resource requirements which apply to each individual container created as part
of the service.<ul><li><strong>Limits</strong> – Define resources limits.<ul><li><strong>NanoCPUs</strong> – CPU limit in units of 10<sup>-9</sup> CPU shares.</li><li><strong>MemoryBytes</strong> – Memory limit in Bytes.</li></ul></li><li><strong>Reservation</strong> – Define resources reservation.<ul><li><strong>NanoCPUs</strong> – CPU reservation in units of 10<sup>-9</sup> CPU shares.</li><li><strong>MemoryBytes</strong> – Memory reservation in Bytes.</li></ul></li></ul></li><li><strong>RestartPolicy</strong> – Specification for the restart policy which applies to containers created
as part of this service.<ul><li><strong>Condition</strong> – Condition for restart (<code>none</code>, <code>on-failure</code>, or <code>any</code>).</li><li><strong>Delay</strong> – Delay between restart attempts.</li><li><strong>MaxAttempts</strong> – Maximum attempts to restart a given container before giving up (default value
is 0, which is ignored).</li><li><strong>Window</strong> – Windows is the time window used to evaluate the restart policy (default value is
0, which is unbounded).</li></ul></li><li><strong>Placement</strong> – Restrictions on where a service can run.<ul><li><strong>Constraints</strong> – An array of constraints, e.g. <code>[ "node.role == manager" ]</code>.</li></ul></li></ul></li><li><strong>Mode</strong> – Scheduling mode for the service (<code>replicated</code> or <code>global</code>, defaults to <code>replicated</code>).</li><li><strong>UpdateConfig</strong> – Specification for the update strategy of the service.<ul><li><strong>Parallelism</strong> – Maximum number of tasks to be updated in one iteration (0 means unlimited
parallelism).</li><li><strong>Delay</strong> – Amount of time between updates.</li><li><strong>FailureAction</strong> - Action to take if an updated task fails to run, or stops running during the
update. Values are <code>continue</code> and <code>pause</code>.</li></ul></li><li><strong>Networks</strong> – Array of network names or IDs to attach the service to.</li><li><strong>EndpointSpec</strong> – Properties that can be configured to access and load balance a service.<ul><li><strong>Mode</strong> – The mode of resolution to use for internal load balancing
between tasks (<code>vip</code> or <code>dnsrr</code>). Defaults to <code>vip</code> if not provided.</li><li><strong>Ports</strong> – List of exposed ports that this service is accessible on from
the outside, in the form of:
<code>{"Protocol": &lt;"tcp"|"udp">, "PublishedPort": &lt;port>, "TargetPort": &lt;port>}</code>.
Ports can only be provided if <code>vip</code> resolution mode is used.</li></ul></li></ul><p><strong>Request Headers</strong>:</p><ul><li><strong>Content-type</strong> – Set to <code>"application/json"</code>.</li><li><strong>X-Registry-Auth</strong> – base64-encoded AuthConfig object, containing either
login information, or a token. Refer to the
<a class=link href="index.html#create-an-image">create an image</a>
section for more details.</li></ul><h4 class=scroll-mt-20 id=remove-a-service><a class="text-black dark:text-white no-underline hover:underline" href="index.html#remove-a-service">Remove a service</a></h4><p><code>DELETE /services/(id or name)</code></p><p>Stop and remove the service <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>DELETE /v1.24/services/16253994b7c4 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such service</li><li><strong>406</strong> - node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=inspect-one-or-more-services><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-one-or-more-services">Inspect one or more services</a></h4><p><code>GET /services/(id or name)</code></p><p>Return information on the service <code>id</code>.</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/services/1cb4dnqcyx6m66g2t538x3rxha HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>{
  &quot;ID&quot;: &quot;ak7w3gjqoa3kuz8xcpnyy0pvl&quot;,
  &quot;Version&quot;: {
    &quot;Index&quot;: 95
  },
  &quot;CreatedAt&quot;: &quot;2016-06-07T21:10:20.269723157Z&quot;,
  &quot;UpdatedAt&quot;: &quot;2016-06-07T21:10:20.276301259Z&quot;,
  &quot;Spec&quot;: {
    &quot;Name&quot;: &quot;redis&quot;,
    &quot;TaskTemplate&quot;: {
      &quot;ContainerSpec&quot;: {
        &quot;Image&quot;: &quot;redis&quot;
      },
      &quot;Resources&quot;: {
        &quot;Limits&quot;: {},
        &quot;Reservations&quot;: {}
      },
      &quot;RestartPolicy&quot;: {
        &quot;Condition&quot;: &quot;any&quot;,
        &quot;MaxAttempts&quot;: 0
      },
      &quot;Placement&quot;: {}
    },
    &quot;Mode&quot;: {
      &quot;Replicated&quot;: {
        &quot;Replicas&quot;: 1
      }
    },
    &quot;UpdateConfig&quot;: {
      &quot;Parallelism&quot;: 1,
      &quot;FailureAction&quot;: &quot;pause&quot;
    },
    &quot;EndpointSpec&quot;: {
      &quot;Mode&quot;: &quot;vip&quot;,
      &quot;Ports&quot;: [
        {
          &quot;Protocol&quot;: &quot;tcp&quot;,
          &quot;TargetPort&quot;: 6379,
          &quot;PublishedPort&quot;: 30001
        }
      ]
    }
  },
  &quot;Endpoint&quot;: {
    &quot;Spec&quot;: {
      &quot;Mode&quot;: &quot;vip&quot;,
      &quot;Ports&quot;: [
        {
          &quot;Protocol&quot;: &quot;tcp&quot;,
          &quot;TargetPort&quot;: 6379,
          &quot;PublishedPort&quot;: 30001
        }
      ]
    },
    &quot;Ports&quot;: [
      {
        &quot;Protocol&quot;: &quot;tcp&quot;,
        &quot;TargetPort&quot;: 6379,
        &quot;PublishedPort&quot;: 30001
      }
    ],
    &quot;VirtualIPs&quot;: [
      {
        &quot;NetworkID&quot;: &quot;4qvuz4ko70xaltuqbt8956gd1&quot;,
        &quot;Addr&quot;: &quot;10.255.0.4/16&quot;
      }
    ]
  }
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such service</li><li><strong>406</strong> - node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=update-a-service><a class="text-black dark:text-white no-underline hover:underline" href="index.html#update-a-service">Update a service</a></h4><p><code>POST /services/(id)/update</code></p><p>Update a service. When using this endpoint to create a service using a
private repository from the registry, the <code>X-Registry-Auth</code> header can be used
to update the authentication information for that is stored for the service.
The header contains a base64-encoded AuthConfig object. Refer to the
<a class=link href="index.html#create-an-image">create an
image</a> section for more details.</p><p><strong>Example request</strong>:</p><pre><code>POST /v1.24/services/1cb4dnqcyx6m66g2t538x3rxha/update?version=23 HTTP/1.1
Content-Type: application/json
Content-Length: 12345

{
  &quot;Name&quot;: &quot;top&quot;,
  &quot;TaskTemplate&quot;: {
    &quot;ContainerSpec&quot;: {
      &quot;Image&quot;: &quot;busybox&quot;,
      &quot;Args&quot;: [
        &quot;top&quot;
      ]
    },
    &quot;Resources&quot;: {
      &quot;Limits&quot;: {},
      &quot;Reservations&quot;: {}
    },
    &quot;RestartPolicy&quot;: {
      &quot;Condition&quot;: &quot;any&quot;,
      &quot;MaxAttempts&quot;: 0
    },
    &quot;Placement&quot;: {}
  },
  &quot;Mode&quot;: {
    &quot;Replicated&quot;: {
      &quot;Replicas&quot;: 1
    }
  },
  &quot;UpdateConfig&quot;: {
    &quot;Parallelism&quot;: 1
  },
  &quot;EndpointSpec&quot;: {
    &quot;Mode&quot;: &quot;vip&quot;
  }
}
</code></pre><p><strong>Example response</strong>:</p><pre><code>HTTP/1.1 200 OK
Content-Length: 0
Content-Type: text/plain; charset=utf-8
</code></pre><p><strong>JSON Parameters</strong>:</p><ul><li><strong>Name</strong> – User-defined name for the service. Note that renaming services is not supported.</li><li><strong>Labels</strong> – A map of labels to associate with the service (e.g., <code>{"key":"value", "key2":"value2"}</code>).</li><li><strong>TaskTemplate</strong> – Specification of the tasks to start as part of the new service.<ul><li><strong>ContainerSpec</strong> - Container settings for containers started as part of this task.<ul><li><strong>Image</strong> – A string specifying the image name to use for the container.</li><li><strong>Command</strong> – The command to be run in the image.</li><li><strong>Args</strong> – Arguments to the command.</li><li><strong>Env</strong> – A list of environment variables in the form of <code>["VAR=value"[,"VAR2=value2"]]</code>.</li><li><strong>Dir</strong> – A string specifying the working directory for commands to run in.</li><li><strong>User</strong> – A string value specifying the user inside the container.</li><li><strong>Labels</strong> – A map of labels to associate with the service (e.g.,
<code>{"key":"value", "key2":"value2"}</code>).</li><li><strong>Mounts</strong> – Specification for mounts to be added to containers created as part of the new
service.<ul><li><strong>Target</strong> – Container path.</li><li><strong>Source</strong> – Mount source (e.g. a volume name, a host path).</li><li><strong>Type</strong> – The mount type (<code>bind</code>, or <code>volume</code>).</li><li><strong>ReadOnly</strong> – A boolean indicating whether the mount should be read-only.</li><li><strong>BindOptions</strong> - Optional configuration for the <code>bind</code> type<ul><li><strong>Propagation</strong> – A propagation mode with the value <code>[r]private</code>, <code>[r]shared</code>, or <code>[r]slave</code>.</li></ul></li><li><strong>VolumeOptions</strong> – Optional configuration for the <code>volume</code> type.<ul><li><strong>NoCopy</strong> – A boolean indicating if volume should be
populated with the data from the target. (Default false)</li><li><strong>Labels</strong> – User-defined name and labels for the volume.</li><li><strong>DriverConfig</strong> – Map of driver-specific options.<ul><li><strong>Name</strong> - Name of the driver to use to create the volume</li><li><strong>Options</strong> - key/value map of driver specific options</li></ul></li></ul></li></ul></li><li><strong>StopGracePeriod</strong> – Amount of time to wait for the container to terminate before
forcefully killing it.</li></ul></li><li><strong>Resources</strong> – Resource requirements which apply to each individual container created as part
of the service.<ul><li><strong>Limits</strong> – Define resources limits.<ul><li><strong>CPU</strong> – CPU limit</li><li><strong>Memory</strong> – Memory limit</li></ul></li><li><strong>Reservation</strong> – Define resources reservation.<ul><li><strong>CPU</strong> – CPU reservation</li><li><strong>Memory</strong> – Memory reservation</li></ul></li></ul></li><li><strong>RestartPolicy</strong> – Specification for the restart policy which applies to containers created
as part of this service.<ul><li><strong>Condition</strong> – Condition for restart (<code>none</code>, <code>on-failure</code>, or <code>any</code>).</li><li><strong>Delay</strong> – Delay between restart attempts.</li><li><strong>MaxAttempts</strong> – Maximum attempts to restart a given container before giving up (default value
is 0, which is ignored).</li><li><strong>Window</strong> – Windows is the time window used to evaluate the restart policy (default value is
0, which is unbounded).</li></ul></li><li><strong>Placement</strong> – Restrictions on where a service can run.<ul><li><strong>Constraints</strong> – An array of constraints, e.g. <code>[ "node.role == manager" ]</code>.</li></ul></li></ul></li><li><strong>Mode</strong> – Scheduling mode for the service (<code>replicated</code> or <code>global</code>, defaults to <code>replicated</code>).</li><li><strong>UpdateConfig</strong> – Specification for the update strategy of the service.<ul><li><strong>Parallelism</strong> – Maximum number of tasks to be updated in one iteration (0 means unlimited
parallelism).</li><li><strong>Delay</strong> – Amount of time between updates.</li></ul></li><li><strong>Networks</strong> – Array of network names or IDs to attach the service to.</li><li><strong>EndpointSpec</strong> – Properties that can be configured to access and load balance a service.<ul><li><strong>Mode</strong> – The mode of resolution to use for internal load balancing
between tasks (<code>vip</code> or <code>dnsrr</code>). Defaults to <code>vip</code> if not provided.</li><li><strong>Ports</strong> – List of exposed ports that this service is accessible on from
the outside, in the form of:
<code>{"Protocol": &lt;"tcp"|"udp">, "PublishedPort": &lt;port>, "TargetPort": &lt;port>}</code>.
Ports can only be provided if <code>vip</code> resolution mode is used.</li></ul></li></ul><p><strong>Query parameters</strong>:</p><ul><li><strong>version</strong> – The version number of the service object being updated. This is
required to avoid conflicting writes.</li></ul><p><strong>Request Headers</strong>:</p><ul><li><strong>Content-type</strong> – Set to <code>"application/json"</code>.</li><li><strong>X-Registry-Auth</strong> – base64-encoded AuthConfig object, containing either
login information, or a token. Refer to the
<a class=link href="index.html#create-an-image">create an image</a>
section for more details.</li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – no such service</li><li><strong>406</strong> - node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h3 class=scroll-mt-20 id=310-tasks><a class="text-black dark:text-white no-underline hover:underline" href="index.html#310-tasks">3.10 Tasks</a></h3><p><strong>Note</strong>: Task operations require the engine to be part of a swarm.</p><h4 class=scroll-mt-20 id=list-tasks><a class="text-black dark:text-white no-underline hover:underline" href="index.html#list-tasks">List tasks</a></h4><p><code>GET /tasks</code></p><p>List tasks</p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/tasks HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>[
  {
    &quot;ID&quot;: &quot;0kzzo1i0y4jz6027t0k7aezc7&quot;,
    &quot;Version&quot;: {
      &quot;Index&quot;: 71
    },
    &quot;CreatedAt&quot;: &quot;2016-06-07T21:07:31.171892745Z&quot;,
    &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:31.376370513Z&quot;,
    &quot;Spec&quot;: {
      &quot;ContainerSpec&quot;: {
        &quot;Image&quot;: &quot;redis&quot;
      },
      &quot;Resources&quot;: {
        &quot;Limits&quot;: {},
        &quot;Reservations&quot;: {}
      },
      &quot;RestartPolicy&quot;: {
        &quot;Condition&quot;: &quot;any&quot;,
        &quot;MaxAttempts&quot;: 0
      },
      &quot;Placement&quot;: {}
    },
    &quot;ServiceID&quot;: &quot;9mnpnzenvg8p8tdbtq4wvbkcz&quot;,
    &quot;Slot&quot;: 1,
    &quot;NodeID&quot;: &quot;60gvrl6tm78dmak4yl7srz94v&quot;,
    &quot;Status&quot;: {
      &quot;Timestamp&quot;: &quot;2016-06-07T21:07:31.290032978Z&quot;,
      &quot;State&quot;: &quot;running&quot;,
      &quot;Message&quot;: &quot;started&quot;,
      &quot;ContainerStatus&quot;: {
        &quot;ContainerID&quot;: &quot;e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035&quot;,
        &quot;PID&quot;: 677
      }
    },
    &quot;DesiredState&quot;: &quot;running&quot;,
    &quot;NetworksAttachments&quot;: [
      {
        &quot;Network&quot;: {
          &quot;ID&quot;: &quot;4qvuz4ko70xaltuqbt8956gd1&quot;,
          &quot;Version&quot;: {
            &quot;Index&quot;: 18
          },
          &quot;CreatedAt&quot;: &quot;2016-06-07T20:31:11.912919752Z&quot;,
          &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:29.955277358Z&quot;,
          &quot;Spec&quot;: {
            &quot;Name&quot;: &quot;ingress&quot;,
            &quot;Labels&quot;: {
              &quot;com.docker.swarm.internal&quot;: &quot;true&quot;
            },
            &quot;DriverConfiguration&quot;: {},
            &quot;IPAMOptions&quot;: {
              &quot;Driver&quot;: {},
              &quot;Configs&quot;: [
                {
                  &quot;Subnet&quot;: &quot;10.255.0.0/16&quot;,
                  &quot;Gateway&quot;: &quot;10.255.0.1&quot;
                }
              ]
            }
          },
          &quot;DriverState&quot;: {
            &quot;Name&quot;: &quot;overlay&quot;,
            &quot;Options&quot;: {
              &quot;com.docker.network.driver.overlay.vxlanid_list&quot;: &quot;256&quot;
            }
          },
          &quot;IPAMOptions&quot;: {
            &quot;Driver&quot;: {
              &quot;Name&quot;: &quot;default&quot;
            },
            &quot;Configs&quot;: [
              {
                &quot;Subnet&quot;: &quot;10.255.0.0/16&quot;,
                &quot;Gateway&quot;: &quot;10.255.0.1&quot;
              }
            ]
          }
        },
        &quot;Addresses&quot;: [
          &quot;10.255.0.10/16&quot;
        ]
      }
    ],
  },
  {
    &quot;ID&quot;: &quot;1yljwbmlr8er2waf8orvqpwms&quot;,
    &quot;Version&quot;: {
      &quot;Index&quot;: 30
    },
    &quot;CreatedAt&quot;: &quot;2016-06-07T21:07:30.019104782Z&quot;,
    &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:30.231958098Z&quot;,
    &quot;Name&quot;: &quot;hopeful_cori&quot;,
    &quot;Spec&quot;: {
      &quot;ContainerSpec&quot;: {
        &quot;Image&quot;: &quot;redis&quot;
      },
      &quot;Resources&quot;: {
        &quot;Limits&quot;: {},
        &quot;Reservations&quot;: {}
      },
      &quot;RestartPolicy&quot;: {
        &quot;Condition&quot;: &quot;any&quot;,
        &quot;MaxAttempts&quot;: 0
      },
      &quot;Placement&quot;: {}
    },
    &quot;ServiceID&quot;: &quot;9mnpnzenvg8p8tdbtq4wvbkcz&quot;,
    &quot;Slot&quot;: 1,
    &quot;NodeID&quot;: &quot;60gvrl6tm78dmak4yl7srz94v&quot;,
    &quot;Status&quot;: {
      &quot;Timestamp&quot;: &quot;2016-06-07T21:07:30.202183143Z&quot;,
      &quot;State&quot;: &quot;shutdown&quot;,
      &quot;Message&quot;: &quot;shutdown&quot;,
      &quot;ContainerStatus&quot;: {
        &quot;ContainerID&quot;: &quot;1cf8d63d18e79668b0004a4be4c6ee58cddfad2dae29506d8781581d0688a213&quot;
      }
    },
    &quot;DesiredState&quot;: &quot;shutdown&quot;,
    &quot;NetworksAttachments&quot;: [
      {
        &quot;Network&quot;: {
          &quot;ID&quot;: &quot;4qvuz4ko70xaltuqbt8956gd1&quot;,
          &quot;Version&quot;: {
            &quot;Index&quot;: 18
          },
          &quot;CreatedAt&quot;: &quot;2016-06-07T20:31:11.912919752Z&quot;,
          &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:29.955277358Z&quot;,
          &quot;Spec&quot;: {
            &quot;Name&quot;: &quot;ingress&quot;,
            &quot;Labels&quot;: {
              &quot;com.docker.swarm.internal&quot;: &quot;true&quot;
            },
            &quot;DriverConfiguration&quot;: {},
            &quot;IPAMOptions&quot;: {
              &quot;Driver&quot;: {},
              &quot;Configs&quot;: [
                {
                  &quot;Subnet&quot;: &quot;10.255.0.0/16&quot;,
                  &quot;Gateway&quot;: &quot;10.255.0.1&quot;
                }
              ]
            }
          },
          &quot;DriverState&quot;: {
            &quot;Name&quot;: &quot;overlay&quot;,
            &quot;Options&quot;: {
              &quot;com.docker.network.driver.overlay.vxlanid_list&quot;: &quot;256&quot;
            }
          },
          &quot;IPAMOptions&quot;: {
            &quot;Driver&quot;: {
              &quot;Name&quot;: &quot;default&quot;
            },
            &quot;Configs&quot;: [
              {
                &quot;Subnet&quot;: &quot;10.255.0.0/16&quot;,
                &quot;Gateway&quot;: &quot;10.255.0.1&quot;
              }
            ]
          }
        },
        &quot;Addresses&quot;: [
          &quot;10.255.0.5/16&quot;
        ]
      }
    ]
  }
]
</code></pre><p><strong>Query parameters</strong>:</p><ul><li><strong>filters</strong> – a JSON encoded value of the filters (a <code>map[string][]string</code>) to process on the
services list. Available filters:<ul><li><code>id=&lt;task id></code></li><li><code>name=&lt;task name></code></li><li><code>service=&lt;service name></code></li><li><code>node=&lt;node id or name></code></li><li><code>label=key</code> or <code>label="key=value"</code></li><li><code>desired-state=(running | shutdown | accepted)</code></li></ul></li></ul><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>406</strong> - node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h4 class=scroll-mt-20 id=inspect-a-task><a class="text-black dark:text-white no-underline hover:underline" href="index.html#inspect-a-task">Inspect a task</a></h4><p><code>GET /tasks/(id)</code></p><p>Get details on the task <code>id</code></p><p><strong>Example request</strong>:</p><pre><code>GET /v1.24/tasks/0kzzo1i0y4jz6027t0k7aezc7 HTTP/1.1
</code></pre><p><strong>Example response</strong>:</p><pre><code>{
  &quot;ID&quot;: &quot;0kzzo1i0y4jz6027t0k7aezc7&quot;,
  &quot;Version&quot;: {
    &quot;Index&quot;: 71
  },
  &quot;CreatedAt&quot;: &quot;2016-06-07T21:07:31.171892745Z&quot;,
  &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:31.376370513Z&quot;,
  &quot;Spec&quot;: {
    &quot;ContainerSpec&quot;: {
      &quot;Image&quot;: &quot;redis&quot;
    },
    &quot;Resources&quot;: {
      &quot;Limits&quot;: {},
      &quot;Reservations&quot;: {}
    },
    &quot;RestartPolicy&quot;: {
      &quot;Condition&quot;: &quot;any&quot;,
      &quot;MaxAttempts&quot;: 0
    },
    &quot;Placement&quot;: {}
  },
  &quot;ServiceID&quot;: &quot;9mnpnzenvg8p8tdbtq4wvbkcz&quot;,
  &quot;Slot&quot;: 1,
  &quot;NodeID&quot;: &quot;60gvrl6tm78dmak4yl7srz94v&quot;,
  &quot;Status&quot;: {
    &quot;Timestamp&quot;: &quot;2016-06-07T21:07:31.290032978Z&quot;,
    &quot;State&quot;: &quot;running&quot;,
    &quot;Message&quot;: &quot;started&quot;,
    &quot;ContainerStatus&quot;: {
      &quot;ContainerID&quot;: &quot;e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035&quot;,
      &quot;PID&quot;: 677
    }
  },
  &quot;DesiredState&quot;: &quot;running&quot;,
  &quot;NetworksAttachments&quot;: [
    {
      &quot;Network&quot;: {
        &quot;ID&quot;: &quot;4qvuz4ko70xaltuqbt8956gd1&quot;,
        &quot;Version&quot;: {
          &quot;Index&quot;: 18
        },
        &quot;CreatedAt&quot;: &quot;2016-06-07T20:31:11.912919752Z&quot;,
        &quot;UpdatedAt&quot;: &quot;2016-06-07T21:07:29.955277358Z&quot;,
        &quot;Spec&quot;: {
          &quot;Name&quot;: &quot;ingress&quot;,
          &quot;Labels&quot;: {
            &quot;com.docker.swarm.internal&quot;: &quot;true&quot;
          },
          &quot;DriverConfiguration&quot;: {},
          &quot;IPAMOptions&quot;: {
            &quot;Driver&quot;: {},
            &quot;Configs&quot;: [
              {
                &quot;Subnet&quot;: &quot;10.255.0.0/16&quot;,
                &quot;Gateway&quot;: &quot;10.255.0.1&quot;
              }
            ]
          }
        },
        &quot;DriverState&quot;: {
          &quot;Name&quot;: &quot;overlay&quot;,
          &quot;Options&quot;: {
            &quot;com.docker.network.driver.overlay.vxlanid_list&quot;: &quot;256&quot;
          }
        },
        &quot;IPAMOptions&quot;: {
          &quot;Driver&quot;: {
            &quot;Name&quot;: &quot;default&quot;
          },
          &quot;Configs&quot;: [
            {
              &quot;Subnet&quot;: &quot;10.255.0.0/16&quot;,
              &quot;Gateway&quot;: &quot;10.255.0.1&quot;
            }
          ]
        }
      },
      &quot;Addresses&quot;: [
        &quot;10.255.0.10/16&quot;
      ]
    }
  ]
}
</code></pre><p><strong>Status codes</strong>:</p><ul><li><strong>200</strong> – no error</li><li><strong>404</strong> – unknown task</li><li><strong>406</strong> - node is not part of a swarm</li><li><strong>500</strong> – server error</li></ul><h2 class=scroll-mt-20 id=4-going-further><a class="text-black dark:text-white no-underline hover:underline" href="index.html#4-going-further">4. Going further</a></h2><h3 class=scroll-mt-20 id=41-inside-docker-run><a class="text-black dark:text-white no-underline hover:underline" href="index.html#41-inside-docker-run">4.1 Inside docker run</a></h3><p>As an example, the <code>docker run</code> command line makes the following API calls:</p><ul><li><p>Create the container</p></li><li><p>If the status code is 404, it means the image doesn't exist:</p><ul><li>Try to pull it.</li><li>Then, retry to create the container.</li></ul></li><li><p>Start the container.</p></li><li><p>If you are not in detached mode:</p></li><li><p>Attach to the container, using <code>logs=1</code> (to have <code>stdout</code> and
<code>stderr</code> from the container's start) and <code>stream=1</code></p></li><li><p>If in detached mode or only <code>stdin</code> is attached, display the container's id.</p></li></ul><h3 class=scroll-mt-20 id=42-hijacking><a class="text-black dark:text-white no-underline hover:underline" href="index.html#42-hijacking">4.2 Hijacking</a></h3><p>In this version of the API, <code>/attach</code>, uses hijacking to transport <code>stdin</code>,
<code>stdout</code>, and <code>stderr</code> on the same socket.</p><p>To hint potential proxies about connection hijacking, Docker client sends
connection upgrade headers similarly to websocket.</p><pre><code>Upgrade: tcp
Connection: Upgrade
</code></pre><p>When Docker daemon detects the <code>Upgrade</code> header, it switches its status code
from <strong>200 OK</strong> to <strong>101 UPGRADED</strong> and resends the same headers.</p><h3 class=scroll-mt-20 id=43-cors-requests><a class="text-black dark:text-white no-underline hover:underline" href="index.html#43-cors-requests">4.3 CORS Requests</a></h3><p>To set cross origin requests to the Engine API please give values to
<code>--api-cors-header</code> when running Docker in daemon mode. Set * (asterisk) allows all,
default or blank means CORS disabled</p><pre><code>$ dockerd -H=&quot;192.168.1.9:2375&quot; --api-cors-header=&quot;http://foo.bar&quot;
</code></pre></article></div><div class="sticky top-16 h-screen w-[300px] shrink grow overflow-y-scroll lg:hidden"><aside class="py-4 space-y-4"><p class="flex items-center gap-2"><span class=icon-svg><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="m378-332 363-363q9.067-9 21.533-9Q775-704 784-694.947q9 9.052 9 21.5Q793-661 784-652L399-267q-9 9-21 9t-21-9L175-449q-9-9.067-8.5-21.533Q167-483 176.053-492q9.052-9 21.5-9Q210-501 219-492l159 160z"/></svg></span>
<a class=link target=_blank rel=noopener href="https://github.com/docker/docs/issues/new?template=doc_issue.yml&location=https%3a%2f%2fdocs.docker.com%2fengine%2fapi%2fv1.24%2f&labels=status%2Ftriage">Request changes
<span class="icon-svg icon-xs icon-top"><svg xmlns="http://www.w3.org/2000/svg" width="48" height="48" viewBox="0 -960 960 960"><path d="M180-120q-24 0-42-18t-18-42v-6e2q0-24 18-42t42-18h249q12.75.0 21.375 8.675 8.625 8.676 8.625 21.5.0 12.825-8.625 21.325T429-780H180v6e2h6e2v-249q0-12.75 8.675-21.375 8.676-8.625 21.5-8.625 12.825.0 21.325 8.625T840-429v249q0 24-18 42t-42 18H180zm6e2-617L403-360q-9 9-21 8.5t-21-9.5-9-21 9-21l377-377H549q-12.75.0-21.375-8.675-8.625-8.676-8.625-21.5.0-12.825 8.625-21.325T549-840h291v291q0 12.75-8.675 21.375-8.676 8.625-21.5 8.625-12.825.0-21.325-8.625T780-549v-188z"/></svg></span></a></a></p><div><div class="text-lg pb-2">Contents</div><nav id=TableOfContents><ul><li><a href="index.html#1-brief-introduction">1. Brief introduction</a></li><li><a href="index.html#2-errors">2. Errors</a></li><li><a href="index.html#3-endpoints">3. Endpoints</a><ul><li><a href="index.html#31-containers">3.1 Containers</a></li><li><a href="index.html#32-images">3.2 Images</a></li><li><a href="index.html#33-misc">3.3 Misc</a></li><li><a href="index.html#34-volumes">3.4 Volumes</a></li><li><a href="index.html#35-networks">3.5 Networks</a></li><li><a href="index.html#36-plugins-experimental">3.6 Plugins (experimental)</a></li><li><a href="index.html#37-nodes">3.7 Nodes</a></li><li><a href="index.html#38-swarm">3.8 Swarm</a></li><li><a href="index.html#39-services">3.9 Services</a></li><li><a href="index.html#310-tasks">3.10 Tasks</a></li></ul></li><li><a href="index.html#4-going-further">4. Going further</a><ul><li><a href="index.html#41-inside-docker-run">4.1 Inside <code>docker run</code></a></li><li><a href="index.html#42-hijacking">4.2 Hijacking</a></li><li><a href="index.html#43-cors-requests">4.3 CORS Requests</a></li></ul></li></ul></nav></div></aside></div></main><footer><div class="flex justify-center py-20 px-4 bg-gray-light-200/50 dark:bg-gray-dark-300/50"><div class="flex w-[1200px] flex-col gap-10"><div class="flex sm:flex-col gap-4 items-center justify-evenly"><a class="underline-offset-2 hover:underline" href=https://www.docker.com/>Product offerings</a>
<a class="underline-offset-2 hover:underline" href=https://www.docker.com/pricing/>Pricing</a>
<a class="underline-offset-2 hover:underline" href=https://www.docker.com/company/>About us</a>
<a class="underline-offset-2 hover:underline" href=https://www.docker.com/support/>Support</a>
<a class="underline-offset-2 hover:underline" href=https://github.com/docker/docs/blob/main/CONTRIBUTING.md>Contribute</a></div><hr class="text-divider-light dark:text-divider-dark"><div class="grid grid-cols-3 place-items-center gap-8 md:grid-cols-1"><p class=text-sm>Copyright © 2013-2024 Docker Inc. All rights reserved.</p><div class="flex gap-4"><a class="h-8 w-8 rounded-full fill-blue-light dark:fill-blue-dark" title="X (Twitter)" href=http://twitter.com/docker/><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 29 29"><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M14.62 13.41l-3.3-4.62H9.56l4.09 5.72.51.72 3.51 4.91h1.76l-4.29-6.01-.52-.72z"/><path class="cls-1" d="M14.5.0A14.5 14.5.0 1029 14.5 14.5 14.5.0 0014.5.0zm2.63 20.94-3.55-5.05-4.43 5.05H8l5.07-5.77L8 7.94h3.87l3.36 4.78 4.2-4.78h1.15l-4.84 5.51L21 20.94z"/></g></g></svg>
</a><a class="h-8 w-8 rounded-full fill-blue-light dark:fill-blue-dark" title=LinkedIn href=https://www.linkedin.com/company/docker><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M12 24c6.627.0 12-5.373 12-12S18.627.0 12 0 0 5.373.0 12s5.373 12 12 12zM8.176 9.66H5.174v9.035h3.002V9.66zm-3.18-2.795c0-.885.671-1.56 1.699-1.56 1.027.0 1.66.675 1.679 1.56.0.867-.652 1.562-1.7 1.562h-.018c-1.008.0-1.66-.695-1.66-1.562zm7.845 4.074c.398-.614 1.112-1.49 2.706-1.49 1.976.0 3.457 1.29 3.457 4.065v5.18h-3.002v-4.833c0-1.214-.435-2.043-1.522-2.043-.829.0-1.323.559-1.54 1.098-.08.194-.099.463-.099.733v5.046H9.838s.04-8.187.0-9.035h3.003v1.28z"/></svg>
</a><a class="h-8 w-8 rounded-full fill-blue-light dark:fill-blue-dark" title=Instagram href=https://www.instagram.com/dockerinc/><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M12 24c6.627.0 12-5.373 12-12S18.627.0 12 0 0 5.373.0 12s5.373 12 12 12zM6.984 4.774c.485-.19 1.04-.32 1.853-.359.814-.039 1.074-.048 3.148-.052 2.075-.004 2.335.004 3.15.04.812.035 1.368.164 1.853.352.503.193.93.454 1.355.878s.687.849.883 1.35c.19.486.32 1.041.359 1.854.038.815.048 1.074.052 3.148s-.005 2.335-.04 3.15c-.036.812-.164 1.368-.352 1.854a3.737 3.737.0 01-.878 1.354 3.746 3.746.0 01-1.35.884c-.486.19-1.04.32-1.853.358-.815.039-1.075.048-3.15.052-2.073.004-2.333-.004-3.148-.04-.813-.036-1.369-.163-1.854-.351a3.746 3.746.0 01-1.355-.878 3.74 3.74.0 01-.883-1.352c-.19-.485-.32-1.04-.359-1.852-.039-.815-.048-1.075-.052-3.15-.004-2.073.004-2.333.04-3.148.036-.813.163-1.368.351-1.855.195-.502.455-.929.879-1.354a3.736 3.736.0 011.35-.883zm.523 13.189c.27.103.674.227 1.419.26.806.034 1.047.042 3.086.038 2.04-.004 2.28-.012 3.086-.05.744-.036 1.148-.16 1.417-.266.357-.14.61-.306.877-.573.267-.268.432-.522.57-.879.104-.27.228-.674.26-1.419.035-.805.043-1.047.039-3.086-.004-2.039-.012-2.28-.05-3.086-.036-.744-.16-1.149-.266-1.417a2.366 2.366.0 00-.573-.878 2.364 2.364.0 00-.88-.57c-.269-.103-.674-.227-1.418-.26-.805-.034-1.047-.042-3.086-.038-2.04.004-2.28.012-3.086.05-.744.036-1.148.16-1.417.266a2.38 2.38.0 00-.878.573 2.37 2.37.0 00-.57.88c-.103.269-.227.674-.26 1.418-.034.805-.042 1.047-.038 3.086.004 2.04.013 2.28.05 3.086.035.744.161 1.148.266 1.418.14.356.305.61.573.877.268.266.522.431.88.57zm8.563-9.131a.917.917.0 11-.003-1.833.917.917.0 01.003 1.833zm-4.063 7.09a3.921 3.921.0 11-.015-7.843 3.921 3.921.0 01.015 7.842zm-.012-6.468a2.546 2.546.0 10.01 5.092 2.546 2.546.0 00-.01-5.092z"/></svg>
</a><a class="h-8 w-8 rounded-full fill-blue-light dark:fill-blue-dark" title=YouTube href=http://www.youtube.com/user/dockerrun><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M12 24c6.627.0 12-5.373 12-12S18.627.0 12 0 0 5.373.0 12s5.373 12 12 12zm7.543-15.79a1.971 1.971.0 00-1.392-1.39C16.923 6.49 12 6.49 12 6.49s-4.924.0-6.152.33A1.972 1.972.0 004.457 8.21c-.33 1.229-.33 3.79-.33 3.79s0 2.562.33 3.79c.18.677.714 1.21 1.391 1.391 1.228.329 6.151.329 6.151.329s4.923.0 6.15-.329a1.972 1.972.0 001.393-1.392c.329-1.227.329-3.789.329-3.789s0-2.561-.33-3.79zm-9.117 6.151L14.516 12l-4.09-2.361v4.722z"/></svg>
</a><a class="h-8 w-8 rounded-full fill-blue-light dark:fill-blue-dark" title=Facebook href=https://www.facebook.com/docker.run><svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M13.54 24c5.948-.736 10.552-5.807 10.552-11.954C24.092 5.393 18.699.0 12.046.0S0 5.393.0 12.046c0 5.842 4.158 10.712 9.677 11.813v-8.374H6.538v-3.573h3.139V9.188c0-3.098 1.845-4.81 4.669-4.81 1.352.0 2.767.242 2.767.242v3.042h-1.559c-1.536.0-2.014.953-2.014 1.93v2.32h3.428l-.548 3.573h-2.88V24z"/></svg></a></div><div class="flex items-center gap-4"><a class="underline-offset-2 hover:underline" title="Docker Terms of Service" href=https://www.docker.com/legal/docker-terms-service>Terms of Service</a>
<a class="underline-offset-2 hover:underline" title="Docker Systems Status Page" href=https://www.dockerstatus.com/>Status</a>
<a class="underline-offset-2 hover:underline" title="Docker Legal Terms" href=https://www.docker.com/legal>Legal</a></div></div></div></div></footer></body></html>